[DOCS] Restructure user settings reference pages #125000
Conversation
charlotte-hoblik
added
>docs
|
Pinging @elastic/es-docs (Team:Docs) |
Update link to point to the new Elasticsearch reference content, based on [this issue](#689). For [this pull request](elastic/elasticsearch#125000)
docs/reference/elasticsearch/configuration-reference/auding-settings.md
Outdated
Show resolved
Hide resolved
docs/reference/elasticsearch/configuration-reference/watcher-settings.md
Outdated
Show resolved
Hide resolved
| navigation_title: "Auditing settings" | ||
| mapped_pages: | ||
| - https://www.elastic.co/guide/en/elasticsearch/reference/current/auditing-settings.html | ||
| applies_to: |
There was a problem hiding this comment.
applies_to:
IMO it's useful to add the applies_to frontmatter 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.
I have added the applies_to tag 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.
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.
...nce/elasticsearch/configuration-reference/elastic-cloud-serverless-elasticsearch-settings.md
Outdated
Show resolved
Hide resolved
docs/reference/elasticsearch/configuration-reference/elasticsearch-settings.md
Outdated
Show resolved
Hide resolved
docs/reference/elasticsearch/configuration-reference/elasticsearch-settings.md
Outdated
Show resolved
Hide resolved
docs/reference/elasticsearch/configuration-reference/elasticsearch-settings.md
Outdated
Show resolved
Hide resolved
docs/reference/elasticsearch/configuration-reference/elasticsearch-settings.md
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
I've added some comments but didn't finish reviewing everything, will circle back. In case it's useful, this PR inspired me to tackle similar fixes for the Kibana settings in elastic/kibana#214934
* add elasticsearch settings page * add logo to ech applicable settings * removing ECH settings page * removing duplicate information from ECH * move settings to correcponding page * update configuration page * fix link * Add applies_to frontmatter to auditing settings * remove duplicate how-to pages * fix broken links * replce cloud icon text * adjust settings pages * add applies_to tag --------- Co-authored-by: lcawl <[email protected]>
) * add signposts to docs-content (#124866) * [DOCS] Restructure user settings reference pages (#125000) * add elasticsearch settings page * add logo to ech applicable settings * removing ECH settings page * removing duplicate information from ECH * move settings to correcponding page * update configuration page * fix link * Add applies_to frontmatter to auditing settings * remove duplicate how-to pages * fix broken links * replce cloud icon text * adjust settings pages * add applies_to tag --------- Co-authored-by: lcawl <[email protected]> --------- Co-authored-by: lcawl <[email protected]>
* add elasticsearch settings page * add logo to ech applicable settings * removing ECH settings page * removing duplicate information from ECH * move settings to correcponding page * update configuration page * fix link * Add applies_to frontmatter to auditing settings * remove duplicate how-to pages * fix broken links * replce cloud icon text * adjust settings pages * add applies_to tag --------- Co-authored-by: lcawl <[email protected]>
* add elasticsearch settings page * add logo to ech applicable settings * removing ECH settings page * removing duplicate information from ECH * move settings to correcponding page * update configuration page * fix link * Add applies_to frontmatter to auditing settings * remove duplicate how-to pages * fix broken links * replce cloud icon text * adjust settings pages * add applies_to tag --------- Co-authored-by: lcawl <[email protected]>
This PR restructures ECE, ESS, and Serverless configuration settings, based on this issue