Commit graph

39 commits

Author SHA1 Message Date
Kibana Machine
418281b2d1
[8.x] [Docs] Update nav instructions and sample data installation to accommodate for the solution views (#199163) (#199438)
# Backport

This will backport the following commits from `main` to `8.x`:
- [[Docs] Update nav instructions and sample data installation to
accommodate for the solution views
(#199163)](https://github.com/elastic/kibana/pull/199163)

<!--- Backport version: 9.4.3 -->

### Questions ?
Please refer to the [Backport tool
documentation](https://github.com/sqren/backport)

<!--BACKPORT
[{"author":{"name":"florent-leborgne","email":"florent.leborgne@elastic.co"},"sourceCommit":{"committedDate":"2024-11-08T10:10:32Z","message":"[Docs]
Update nav instructions and sample data installation to accommodate for
the solution views (#199163)\n\nThis PR:\r\n- updates navigation
instructions to accommodate for the navigation\r\nchanges related to
solution views.\r\n- updates instructions for adding sample data to rely
on the\r\nintegrations page instead of the home page, that only exists
with the\r\nclassic solution view\r\n- updates references to the home
page to avoid confusing users using one\r\nof the new solution
views\r\n\r\nCloses:
https://github.com/elastic/platform-docs-team/issues/529\r\nCloses:
https://github.com/elastic/platform-docs-team/issues/540","sha":"8e7fb7a77e2399e3e946bbba0462517fd7dad0f7","branchLabelMapping":{"^v9.0.0$":"main","^v8.17.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["Team:Docs","release_note:skip","v9.0.0","docs","v8.16.0","backport:version","v8.17.0"],"title":"[Docs]
Update nav instructions and sample data installation to accommodate for
the solution
views","number":199163,"url":"https://github.com/elastic/kibana/pull/199163","mergeCommit":{"message":"[Docs]
Update nav instructions and sample data installation to accommodate for
the solution views (#199163)\n\nThis PR:\r\n- updates navigation
instructions to accommodate for the navigation\r\nchanges related to
solution views.\r\n- updates instructions for adding sample data to rely
on the\r\nintegrations page instead of the home page, that only exists
with the\r\nclassic solution view\r\n- updates references to the home
page to avoid confusing users using one\r\nof the new solution
views\r\n\r\nCloses:
https://github.com/elastic/platform-docs-team/issues/529\r\nCloses:
https://github.com/elastic/platform-docs-team/issues/540","sha":"8e7fb7a77e2399e3e946bbba0462517fd7dad0f7"}},"sourceBranch":"main","suggestedTargetBranches":["8.16","8.x"],"targetPullRequestStates":[{"branch":"main","label":"v9.0.0","branchLabelMappingKey":"^v9.0.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/199163","number":199163,"mergeCommit":{"message":"[Docs]
Update nav instructions and sample data installation to accommodate for
the solution views (#199163)\n\nThis PR:\r\n- updates navigation
instructions to accommodate for the navigation\r\nchanges related to
solution views.\r\n- updates instructions for adding sample data to rely
on the\r\nintegrations page instead of the home page, that only exists
with the\r\nclassic solution view\r\n- updates references to the home
page to avoid confusing users using one\r\nof the new solution
views\r\n\r\nCloses:
https://github.com/elastic/platform-docs-team/issues/529\r\nCloses:
https://github.com/elastic/platform-docs-team/issues/540","sha":"8e7fb7a77e2399e3e946bbba0462517fd7dad0f7"}},{"branch":"8.16","label":"v8.16.0","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"8.x","label":"v8.17.0","branchLabelMappingKey":"^v8.17.0$","isSourceBranch":false,"state":"NOT_CREATED"}]}]
BACKPORT-->

Co-authored-by: florent-leborgne <florent.leborgne@elastic.co>
2024-11-08 10:41:00 +00:00
Kibana Machine
7cefd3cda6
[8.x] [Docs] Refresh dev tools Console page (#193530) (#194259)
# Backport

This will backport the following commits from `main` to `8.x`:
- [[Docs] Refresh dev tools Console page
(#193530)](https://github.com/elastic/kibana/pull/193530)

<!--- Backport version: 9.4.3 -->

### Questions ?
Please refer to the [Backport tool
documentation](https://github.com/sqren/backport)

<!--BACKPORT
[{"author":{"name":"florent-leborgne","email":"florent.leborgne@elastic.co"},"sourceCommit":{"committedDate":"2024-09-27T07:59:53Z","message":"[Docs]
Refresh dev tools Console page (#193530)\n\n## Summary\r\n\r\nThis PR
updates the docs page about using the Dev Tools Console.\r\n\r\nCloses:
https://github.com/elastic/kibana/issues/191271","sha":"c435b57526a74fcbcbdea11fb4839ffe7ce2dc24","branchLabelMapping":{"^v9.0.0$":"main","^v8.16.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["Team:Docs","release_note:skip","v9.0.0","v8.16.0","backport:version"],"title":"[Docs]
Refresh dev tools Console
page","number":193530,"url":"https://github.com/elastic/kibana/pull/193530","mergeCommit":{"message":"[Docs]
Refresh dev tools Console page (#193530)\n\n## Summary\r\n\r\nThis PR
updates the docs page about using the Dev Tools Console.\r\n\r\nCloses:
https://github.com/elastic/kibana/issues/191271","sha":"c435b57526a74fcbcbdea11fb4839ffe7ce2dc24"}},"sourceBranch":"main","suggestedTargetBranches":["8.x"],"targetPullRequestStates":[{"branch":"main","label":"v9.0.0","branchLabelMappingKey":"^v9.0.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/193530","number":193530,"mergeCommit":{"message":"[Docs]
Refresh dev tools Console page (#193530)\n\n## Summary\r\n\r\nThis PR
updates the docs page about using the Dev Tools Console.\r\n\r\nCloses:
https://github.com/elastic/kibana/issues/191271","sha":"c435b57526a74fcbcbdea11fb4839ffe7ce2dc24"}},{"branch":"8.x","label":"v8.16.0","branchLabelMappingKey":"^v8.16.0$","isSourceBranch":false,"state":"NOT_CREATED"}]}]
BACKPORT-->

Co-authored-by: florent-leborgne <florent.leborgne@elastic.co>
2024-09-27 08:27:49 +00:00
Youhei Sakurai
ceb7ad761d
Sort out objectization in variable substitution (#162382)
Closes #162381

## Summary

This PR is,,,

1. Adding documentation about objectization in variable substitution.
2. Fixing a glitch in the illegal double quotes `""`.
    <details open="true"><summary>details</summary>
    
For example, `""${ZERO}""` may have substituted `"0"` but this
substitution must not occur because no quotes surround the `${ZERO}` in
the context of JSON syntax. `""${ZERO}""` is jut `${ZERO}` with forward
and training `""`.</details>
3. Promoting triple quotes `"""` as an alternative to the illegal double
quotes `""`.
    <details open="true"><summary>details</summary>
    
Now `"""${ZERO}"""` is a way to substitute `"""0"""` rather than `0`
that `"${ZERO}"` may substitute. The same as before, these single and
triple quotes work only in the request body.</details>

### Checklist

- [x] Any text added follows [EUI's writing
guidelines](https://elastic.github.io/eui/#/guidelines/writing), uses
sentence case text and includes [i18n
support](https://github.com/elastic/kibana/blob/main/packages/kbn-i18n/README.md)
- [x]
[Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html)
was added for features that require explanation or tutorials
- [x] [Unit or functional
tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html)
were updated or added to match the most common scenarios
- [x] This was checked for [cross-browser
compatibility](https://www.elastic.co/support/matrix#matrix_browsers)

Note: Regex negative lookahead `x(?!y)` and ~~lookbehind `(?<!y)x`~~
(_EDIT: no lookbehind anymore_) assertions
([cf.](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_expressions/Assertions#other_assertions))
are used in this PR. So, I've checked the following steps on each
browser.

Browsers:
- Chrome 115.0.5790.102
- Firefox 115.0.2
- Edge 115.0.1901.183
- Safari 16.3 (18614.4.6.1.6) ~~CAN'T CHECK~~ - Safari has recently
added support for the negative lookbehind as per this 16.4 release note.

>
https://developer.apple.com/documentation/safari-release-notes/safari-16_4-release-notes
> Added support for RegExp lookbehind assertions.

Steps:
1. Go to Dev Tools > Console.
2. Click `Variables` on the top.
4. Define variable `ZERO` with `0`.
6. Run the following command.

```http
POST test/_doc
{
  "field": "${ZERO}"
}
```

### For maintainers

- [x] This was checked for breaking API changes and was [labeled
appropriately](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process)

## Release note

Improves a way of variable substitution and its documentation

---------

Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>
2023-07-27 09:30:52 +09:00
CJ Cenizal
dfb110cad2
Add Console docs for Comments and Variables (#137225)
* Update console-settings.png and console.png. Remove settings.png.
* Fix image names and alt tags.
* Remove unnecessary whitespace, backticks, and typo bracket.
2022-07-28 10:52:20 -07:00
gchaps
0d5808a22b
[DOCS] Adds Kibana API support to Console (#134111)
* [DOCS] Adds Kibana API support to Console

* Update docs/dev-tools/console/console.asciidoc

Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co>

Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co>
2022-06-13 09:03:44 -07:00
gchaps
e9b1d3834a
[DOCS] Fixes typo in Console doc (#132078)
* [DOCS] Fixes typo in Console doc

This PR fixes a typo in the Console doc.

* Update docs/dev-tools/console/console.asciidoc

* Update docs/dev-tools/console/console.asciidoc
2022-05-12 09:23:30 -07:00
Sébastien Loix
f6a9afea61
[Stack management apps] Deprecate "enabled" Kibana setting (#114768) 2021-10-19 11:33:57 +01:00
Luke Elmers
94aa791a49
[Breaking] Remove deprecated enabled settings from plugins. (#113495) 2021-10-17 16:54:30 +01:00
James Rodewig
40f2784f37
Rename 'Ingest Node Pipelines' to 'Ingest Pipelines' (#113783)
While Elasticsearch ingest pipelines require a node with the `ingest`
role, we don't need to include `ingest node` in the feature name.

There are no official plans, but the Elasticsearch team has discussed removing
the `ingest` role in the future. This also better aligns the Kibana UI with the
Elasticsearch docs.

The PR also makes some related changes to the Kibana docs.

Relates to https://github.com/elastic/elasticsearch/pull/70253.
2021-10-05 16:03:11 -04:00
Luke Elmers
878b1eeae9
Log deprecation warnings for plugins which won't be disable-able in 8.0 (#112602) 2021-09-22 15:58:57 -04:00
gchaps
8115a76b8b
[DOCS][DEV TOOLS] Uses task-oriented titles (#106796) 2021-07-26 14:53:49 -07:00
gchaps
d3defc0960
Updates painless doc to use runtime fields (#106462) 2021-07-21 13:24:59 -07:00
gchaps
646df22ede
[DOCS] Updates screenshots in Dev Tools docs (#105859)
* [DOCS] Updates screenshots in Dev Tools docs

* [DOCS] Combines all Search Profiler content in one doc
2021-07-20 14:33:06 -07:00
Alison Goryachev
76f8dbbd4a
[Console] Update docs (#92240) 2021-02-22 20:44:39 -05:00
gchaps
b18e4ec9b8
[DOCS] Uses variable to refer to query profiler (#90976) 2021-02-10 13:05:33 -08:00
Kaarina Tungseth
c77619352b
[DOCS] 7.10 Core UI changes (#80407)
* [DOCS] 7.10 screenCore UI changes

* Kibana access options

* Removed Kibana from Set up Kibana

* Removed rogue symbols

* Update docs/spaces/index.asciidoc

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>

* Update docs/management/managing-beats.asciidoc

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>

* Review comments

* Update docs/user/introduction.asciidoc

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>

* Review comments

* Changed menu to main menu

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>
2020-10-22 09:06:51 -05:00
Lisa Cawley
7aa600bff7
[DOCS] Removes occurrences of X-Pack Security and Reporting (#72302) 2020-07-17 14:53:04 -07:00
Kaarina Tungseth
a5bbbf96b5
[DOCS] Image cleanup (#71258)
* [DOCS] Image clean up

* Second half of images folder

* Fixes errors
2020-07-09 10:38:50 -05:00
Kaarina Tungseth
896b9cddbc
[DOCS] Updates for navigation redesign (#68709)
* [DOCS] Updates for navigation redesign

* Getting started

* Set up text

* Discover

* Dashboard, Graph, ML, Maps, APM, SIEM, Dev tools

* Dev Tools, Stack Monitoring, Management

* Management

* Final changes

* [DOCS] Updates for navigation redesign

* [DOCS] Updates CCR monitoring screenshots

* updates SIEM screenshot and Cases overview text

* Added Brandon's APM image

* [DOCS] Refines CCR shard screenshot

* Removed merge conflict image file

Co-authored-by: lcawl <lcawley@elastic.co>
Co-authored-by: Ben Skelker <ben.skelker@elastic.co>
2020-06-12 09:39:36 -05:00
gchaps
de62abbd4e
[DOCS] Fixes typo in Console docs (#68536) 2020-06-08 14:45:55 -07:00
gchaps
9fd63a7daa
[DOCS] Adds docs for Painless Lab (#62997)
* [DOCS] Adds docs for Painless Lab

* [DOCS] Incorporated review comments
2020-04-09 11:31:19 -07:00
Kaarina Tungseth
809ec97649
[DOCS] Removed references to left (#60807)
* [DOCS] Removed references to left

* Fixed broken build
2020-04-06 15:37:45 -05:00
Kaarina Tungseth
56006534af
[DOCS] Removed below references (#60159) 2020-03-16 09:58:16 -05:00
Kaarina Tungseth
84f6885c36
[DOCS] Removed spatial references (#59595)
* [DOCS] Removed ss above spatial references

* Removed above from n numeral formatting page
2020-03-09 10:29:25 -05:00
Kaarina Tungseth
1e3f14395c
[DOCS] API intro (#47164)
* [DOCS] API intro

* Logstash configuration management

* Reformatting

* Comments from Josh

* Commets from Gail

* Fixed broken things
2019-10-16 15:10:40 -05:00
gchaps
751f2ee2e6
[DOCS] Updates Console doc (#41371)
* [DOCS] Updates Console doc

* [DOCS] Incorporates comments on Console docs

* [DOCS] Updated Console images
2019-07-23 10:58:45 -07:00
James Rodewig
6d7ccbe2a0
[DOCS] Update anchors and links for Elasticserach API relocation. (#41372) 2019-07-19 15:16:57 -04:00
James Rodewig
8571d56839
Revert "[DOCS] Fix broken links for ES API docs move (#41001)" (#41056)
This reverts commit dd34150467.
2019-07-12 17:40:59 -04:00
James Rodewig
dd34150467
[DOCS] Fix broken links for ES API docs move (#41001) 2019-07-12 12:15:40 -04:00
Sarah Hersh
5401d80eb1
update screenshots and edit docs for search profiler (#36589) 2019-05-21 09:55:24 -04:00
gchaps
883ff0c26b [DOCS] Updates docs for Grok Debugger (#36289) 2019-05-09 15:22:28 -04:00
Sarah Hersh
4a21108c29
[DOCS] Updates docs for Console (#35505)
* update docs and screenshots

* [DOCS] Updates Console text and images
2019-04-24 15:06:30 -04:00
Lisa Cawley
6ac4dcbe0b
[DOCS] Use search profiler attribute (#28209) 2019-01-08 10:28:02 -08:00
Lisa Cawley
61fcf98b6e
[DOCS] Updates X-Pack terminology (#28208) 2019-01-08 08:48:36 -08:00
Nathan Reese
fd8c36e372
fix console documenation (#27862) 2018-12-31 11:29:42 -07:00
Lisa Cawley
e65ad31de7
[DOCS] Fix links to search profiling (#27501) 2018-12-19 07:56:13 -08:00
Sarah Hersh
5c1615dd96
[DOCS] Kibana APIs not accessible via Console (#26221) 2018-12-05 16:20:58 -05:00
Court Ewing
fd050fbcd3
docs: note about permissions for grok debugger (#23664) 2018-10-03 11:35:46 -04:00
Lisa Cawley
a13377034a
[DOCS] Creates dev-tools folder (#19528) 2018-05-29 22:37:51 -07:00