-
Notifications
You must be signed in to change notification settings - Fork 25.6k
[DOCS] Restructure user settings reference pages #125000
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
Merged
Merged
Changes from all commits
Commits
Show all changes
14 commits
Select commit
Hold shift + click to select a range
2d2e7cf
add elasticsearch settings page
charlotte-hoblik d8fae48
add logo to ech applicable settings
charlotte-hoblik d939182
removing ECH settings page
charlotte-hoblik c217fee
removing duplicate information from ECH
charlotte-hoblik 09323d3
move settings to correcponding page
charlotte-hoblik 47a41c5
update configuration page
charlotte-hoblik a03692d
fix link
charlotte-hoblik 3f002b4
Add applies_to frontmatter to auditing settings
lcawl 13f106f
Merge branch 'main' into charlotte-elasticsearch-settings-689
charlotte-hoblik 5ef3a62
remove duplicate how-to pages
charlotte-hoblik 93865f4
fix broken links
charlotte-hoblik 2c5518a
replce cloud icon text
charlotte-hoblik b35556e
adjust settings pages
charlotte-hoblik fc97d55
add applies_to tag
charlotte-hoblik File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
3 changes: 3 additions & 0 deletions
3
...nce/elasticsearch/configuration-reference/cross-cluster-replication-settings.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
3 changes: 3 additions & 0 deletions
3
...e/elasticsearch/configuration-reference/discovery-cluster-formation-settings.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
IMO it's useful to add the
applies_tofrontmatter on this type of page per https://docs-v3-preview.elastic.dev/elastic/docs-builder/tree/main/versions/content-patterns#page-level-applies-tags because otherwise it kind of looks like this page maybe only applies to Cloud, which I don't think is the case.This page is also a bit usual because all the settings do apply to Cloud, so in theory there's no point to putting the icon on them--the frontmatter accurately reflects the availability. However, since we want this page to align with all the other setting pages in this section, for now I think it makes sense to leave the redundant cloud icons.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I have added the
applies_totag to the pages as suggested. However, as Shaina mentioned in her comment I’m unsure whether ECE and ECH support the same settings. I wasn’t able to find a definitive source in the existing documentation.Would you happen to know where I could verify this or who might be the best person to ask? The ECE documentation doesn’t seem to list supported settings in the same way as the ECH documentation.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah, I couldn't tell in the Kibana settings either, so I put comments with "TBD" questions and annotated the text only what was clearly stated in the old docs. I can see how this was a poor experience for our users trying to figure this out, so we'll definitely need thorough reviews when these settings move to their final yaml-derived state.