Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve the documentation around Elasticsearch secure settings #5425

Closed
pebrc opened this issue Mar 2, 2022 · 0 comments · Fixed by #5965
Closed

Improve the documentation around Elasticsearch secure settings #5425

pebrc opened this issue Mar 2, 2022 · 0 comments · Fixed by #5965
Assignees
Labels
>docs Documentation

Comments

@pebrc
Copy link
Collaborator

pebrc commented Mar 2, 2022

The current documentation is at https://www.elastic.co/guide/en/cloud-on-k8s/current/k8s-es-secure-settings.html

It can be very confusing to users, the key, path projection mechanism is not something users need to understand for basic usage but it is presented in one continuous paragraph with the basic use of the feature.

We could improve this as follows:

  • have three sections maybe (titles tbd): basic usage, projection/subset usage, examples
  • most users will learn all they need in the basic section and can ignore the complicated projection feature
  • examples: we already link to a GCS example for snapshots, we could highlight this a bit more and add another example inline maybe for AWS S3 .
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
>docs Documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant