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

Add ESS icons to Elasticsearch docs for supported Cloud settings #57486

Closed
lockewritesdocs opened this issue Jun 1, 2020 · 3 comments · Fixed by #57953
Closed

Add ESS icons to Elasticsearch docs for supported Cloud settings #57486

lockewritesdocs opened this issue Jun 1, 2020 · 3 comments · Fixed by #57953
Assignees
Labels
>docs General docs changes Team:Docs Meta label for docs team

Comments

@lockewritesdocs
Copy link
Contributor

The ES Docs do not indicate if a setting is supported on ESS. This discrepancy has resulted in support cases where a user tries an unsupported setting and it fails.

As part of the Cloud-first workgroup, the ES reference needs a PR like this one to add the ESS icon for supported settings, based on:

Output looks like https://www.elastic.co/guide/en/kibana/current/settings.html

It's possible that the Cloud docs are incomplete, meaning that settings are whitelisted but not documented anywhere. For example, these security settings are whitelisted in the Cloud docs, but are not shown as Cloud-compatible in the ES Audit Security Settings. Each of the supported settings should use the ESS icon.

Related to #48412.

@lockewritesdocs lockewritesdocs added WIP :Search/Search Search-related issues that do not fall into other categories Team:Docs Meta label for docs team labels Jun 1, 2020
@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-search (:Search/Search)

@elasticmachine elasticmachine added the Team:Search Meta label for search team label Jun 1, 2020
@lockewritesdocs lockewritesdocs self-assigned this Jun 1, 2020
@jimczi jimczi added >docs General docs changes and removed :Search/Search Search-related issues that do not fall into other categories labels Jun 3, 2020
@elasticmachine elasticmachine removed the Team:Search Meta label for search team label Jun 3, 2020
@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-docs (>docs)

@lockewritesdocs
Copy link
Contributor Author

lockewritesdocs commented Jun 26, 2020

After discussion with the larger team, we decided to add the ESS icon for ES settings supported on Cloud, but not produce a full list. A separate PR will be opened by @gtback to develop an automated solution that reads through the ES configuration settings code and pulls tagged content for supported settings into a Cloud settings page.

This automated approach reduces maintenance overhead and ensures that we generate the full list of Cloud settings without having to manually build the page. When this automated solution is complete, we will build a complete list of Cloud settings, and also share the solution with the Kibana team so that they do the same.

cc: @nrichers for visibility

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
>docs General docs changes Team:Docs Meta label for docs team
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants