Update elasticsearch-keystore.md with special character handling and echo command to enter the password. #127135

mailahmeduk · 2025-04-22T02:04:11Z

Customer needs document update for handling special characters and how we can use the echo command to enter the password.

Have you signed the contributor license agreement?
Have you followed the contributor guidelines?
If submitting code, have you built your formula locally prior to submission with gradle check?
If submitting code, is your pull request against main? Unless there is a good reason otherwise, we prefer pull requests against main and will backport as needed.
If submitting code, have you checked that your submission is for an OS and architecture that we support?
If you are submitting this code for a class then read our policy for that.

Customer needs document update for handling special characters and how we can use the echo command to enter the password.

elasticsearchmachine · 2025-04-22T02:04:34Z

@mailahmeduk please enable the option "Allow edits and access to secrets by maintainers" on your PR. For more information, see the documentation.

elasticsearchmachine · 2025-04-22T02:09:28Z

Pinging @elastic/es-docs (Team:Docs)

geekpete · 2025-04-22T03:31:58Z

The only change I would suggest is to put this in an admonition paragraph (prefix with NOTE: or appropriate admonition type), so that this advice stands out in the page.:
https://github.com/elastic/docs?tab=readme-ov-file#admonition-paragraphs

Or alternatively this section might go into an admonition block:
https://github.com/elastic/docs?tab=readme-ov-file#admon-blocks

and pick an appropriate level of admonition to use.
Some advice on admonition levels I saw was:

In software, we more typically think of the potential hazard to your data:
WARNING you could permanently lose data or leak sensitive information.
IMPORTANT ignoring the information could impact performance or the stability of your system, but your data is not at risk.
NOTE a relevant piece of information, but there are no serious repercussions if you ignore.
TIP a piece of advice intended to help you make better choices in how you use the feature.

so probably either NOTE or IMPORTANT based on the impact that might occur if the characters are not correctly escaped.

leemthompo · 2025-04-22T07:44:04Z

I think in this we should move the guidance out of the Examples section and put it in a standalone section titled "Handling special characters", just after Parameters:

that way we don't need to use admonitions just to make it stand out
users will know about working with special characters before jumping into examples

docs/reference/elasticsearch/command-line-tools/elasticsearch-keystore.md

…keystore.md Co-authored-by: Liam Thompson <[email protected]>

leemthompo · 2025-04-22T08:35:09Z

thanks @mailahmeduk! all need to do now is move the new section up before the Examples section

Moving the section out of Examples as advised.

mailahmeduk

Thanks. @leemthompo
Made changes as advised.

docs/reference/elasticsearch/command-line-tools/elasticsearch-keystore.md

…keystore.md Co-authored-by: Liam Thompson <[email protected]>

mailahmeduk · 2025-04-22T09:00:28Z

Can you please review the syntax, something doesn't look right.

leemthompo · 2025-04-22T09:05:52Z

@mailahmeduk the docs markdown syntax won't render nicely in the Github preview, but you can see it works as expected in the docs preview :)

docs/reference/elasticsearch/command-line-tools/elasticsearch-keystore.md

…keystore.md Co-authored-by: Liam Thompson <[email protected]>

leemthompo

LGTM, provided @geekpete is happy :)

geekpete

LGTM!

leemthompo · 2025-04-23T08:37:37Z

💚 All backports created successfully

Status	Branch	Result
✅	9.0

Questions ?

Please refer to the Backport tool documentation

…echo command to enter the password. (elastic#127135) * Update elasticsearch-keystore.md Customer needs document update for handling special characters and how we can use the echo command to enter the password. * Update docs/reference/elasticsearch/command-line-tools/elasticsearch-keystore.md Co-authored-by: Liam Thompson <[email protected]> * Update docs/reference/elasticsearch/command-line-tools/elasticsearch-keystore.md Co-authored-by: Liam Thompson <[email protected]> * Update elasticsearch-keystore.md Moving the section out of Examples as advised. * Update docs/reference/elasticsearch/command-line-tools/elasticsearch-keystore.md Co-authored-by: Liam Thompson <[email protected]> * Update docs/reference/elasticsearch/command-line-tools/elasticsearch-keystore.md Co-authored-by: Liam Thompson <[email protected]> --------- Co-authored-by: Liam Thompson <[email protected]> (cherry picked from commit 98a3719)

…echo command to enter the password. (#127135) (#127217) * Update elasticsearch-keystore.md Customer needs document update for handling special characters and how we can use the echo command to enter the password. * Update docs/reference/elasticsearch/command-line-tools/elasticsearch-keystore.md Co-authored-by: Liam Thompson <[email protected]> * Update docs/reference/elasticsearch/command-line-tools/elasticsearch-keystore.md Co-authored-by: Liam Thompson <[email protected]> * Update elasticsearch-keystore.md Moving the section out of Examples as advised. * Update docs/reference/elasticsearch/command-line-tools/elasticsearch-keystore.md Co-authored-by: Liam Thompson <[email protected]> * Update docs/reference/elasticsearch/command-line-tools/elasticsearch-keystore.md Co-authored-by: Liam Thompson <[email protected]> --------- Co-authored-by: Liam Thompson <[email protected]> (cherry picked from commit 98a3719) Co-authored-by: Ahmed Khan <[email protected]>

Update elasticsearch-keystore.md

1caaa9f

Customer needs document update for handling special characters and how we can use the echo command to enter the password.

mailahmeduk requested review from colleenmcginnis and geekpete April 22, 2025 02:04

elasticsearchmachine added needs:triage Requires assignment of a team area label v9.1.0 external-contributor Pull request authored by a developer outside the Elasticsearch team labels Apr 22, 2025

mailahmeduk added the >docs General docs changes label Apr 22, 2025

elasticsearchmachine added Team:Docs Meta label for docs team and removed needs:triage Requires assignment of a team area label labels Apr 22, 2025

leemthompo reviewed Apr 22, 2025

View reviewed changes

docs/reference/elasticsearch/command-line-tools/elasticsearch-keystore.md Outdated Show resolved Hide resolved

leemthompo reviewed Apr 22, 2025

View reviewed changes

docs/reference/elasticsearch/command-line-tools/elasticsearch-keystore.md Outdated Show resolved Hide resolved

mailahmeduk and others added 2 commits April 22, 2025 18:26

Update docs/reference/elasticsearch/command-line-tools/elasticsearch-…

0c49500

…keystore.md Co-authored-by: Liam Thompson <[email protected]>

Update docs/reference/elasticsearch/command-line-tools/elasticsearch-…

a485fc6

…keystore.md Co-authored-by: Liam Thompson <[email protected]>

leemthompo added auto-backport Automatically create backport pull requests when merged v9.0.0 labels Apr 22, 2025

leemthompo self-assigned this Apr 22, 2025

Update elasticsearch-keystore.md

6d9a60d

Moving the section out of Examples as advised.

mailahmeduk commented Apr 22, 2025

View reviewed changes

leemthompo reviewed Apr 22, 2025

View reviewed changes

docs/reference/elasticsearch/command-line-tools/elasticsearch-keystore.md Show resolved Hide resolved

Update docs/reference/elasticsearch/command-line-tools/elasticsearch-…

a48c492

…keystore.md Co-authored-by: Liam Thompson <[email protected]>

leemthompo reviewed Apr 22, 2025

View reviewed changes

docs/reference/elasticsearch/command-line-tools/elasticsearch-keystore.md Outdated Show resolved Hide resolved

Update docs/reference/elasticsearch/command-line-tools/elasticsearch-…

8f0ecb7

…keystore.md Co-authored-by: Liam Thompson <[email protected]>

leemthompo removed the request for review from colleenmcginnis April 22, 2025 14:26

leemthompo approved these changes Apr 22, 2025

View reviewed changes

geekpete approved these changes Apr 23, 2025

View reviewed changes

Merge branch 'main' into mailahmeduk-patch-1

5bdfa62

leemthompo enabled auto-merge (squash) April 23, 2025 07:34

leemthompo merged commit 98a3719 into main Apr 23, 2025
7 checks passed

leemthompo deleted the mailahmeduk-patch-1 branch April 23, 2025 07:40

leemthompo mentioned this pull request Apr 23, 2025

[9.0] Update elasticsearch-keystore.md with special character handling and echo command to enter the password. (#127135) #127217

Merged

Update elasticsearch-keystore.md with special character handling and echo command to enter the password. #127135

Update elasticsearch-keystore.md with special character handling and echo command to enter the password. #127135

Uh oh!

Conversation

mailahmeduk commented Apr 22, 2025

Uh oh!

elasticsearchmachine commented Apr 22, 2025

Uh oh!

elasticsearchmachine commented Apr 22, 2025

Uh oh!

geekpete commented Apr 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

leemthompo commented Apr 22, 2025

Uh oh!

Uh oh!

Uh oh!

leemthompo commented Apr 22, 2025

Uh oh!

mailahmeduk left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

mailahmeduk commented Apr 22, 2025

Uh oh!

leemthompo commented Apr 22, 2025

Uh oh!

Uh oh!

leemthompo left a comment

Choose a reason for hiding this comment

Uh oh!

geekpete left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

leemthompo commented Apr 23, 2025

💚 All backports created successfully

Questions ?

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

geekpete commented Apr 22, 2025 •

edited

Loading

mailahmeduk left a comment •

edited

Loading