Commit graph

21 commits

Author SHA1 Message Date
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
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
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
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
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
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
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
Nathan Reese
fd8c36e372
fix console documenation (#27862) 2018-12-31 11:29:42 -07:00
Sarah Hersh
5c1615dd96
[DOCS] Kibana APIs not accessible via Console (#26221) 2018-12-05 16:20:58 -05:00
Lisa Cawley
a13377034a
[DOCS] Creates dev-tools folder (#19528) 2018-05-29 22:37:51 -07:00