Skip to content

Conversation

shainaraskas
Copy link
Contributor

@shainaraskas shainaraskas commented Dec 30, 2024

This PR edits the Configuring Elasticsearch section to separate conceptual/instructional information from the ES settings reference.

only to be reviewed after #119016 is merged

Notable changes

Change Link
Dedicated node.attr.<attribute-name> docs (these were buried in the shard allocation awareness docs) Custom node attributes
Moved core data store concepts into child pages of the data store architecture section
Moved node role conceptual docs into its own page Node roles
Moved info about the processes that are executed during downsampling out of the API docs and into the downsampling conceptual page 1, 2
Small tweak to pull conceptual content above setting content for watermark setting max headroom, simplify language, + removed low-value example Max headroom
Refactored the "publishing the cluster state" concept page into a complete "cluster state" concept page - allowed me to remove dangling indices info from modules-gateway.html Cluster state
Moved TCP readiness port docs to networking page so the remaining content on the page is just JVM options (which will not be included in the settings reference in future) TCP readiness port, Set JVM options
Distributed important cluster settings that were only documented on "important cluster settings" page onto their relevant setting pages
Moved logging doc to monitoring section Elasticsearch application logging
Refactored some misc sections linking between related sections into notes n/a
Fixed some section nesting n/a
Alphabetized setting pages (they were NEARLY alphabetical) n/a

TODO

  • Networking page has a dense mixture of conceptual info and settings info - will split it in a later PR
  • new path settings page needs to be refined to just have settings only

Copy link
Contributor

Documentation preview:

@shainaraskas shainaraskas changed the title Concept cleanup 2 [DOCS] Concept cleanup 2 - ES settings Dec 31, 2024
@shainaraskas shainaraskas added v8.17.1 v8.18.0 >docs General docs changes Team:Docs Meta label for docs team labels Jan 2, 2025
@shainaraskas shainaraskas marked this pull request as ready for review January 2, 2025 15:16
@elasticsearchmachine
Copy link
Collaborator

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

Copy link
Contributor

@leemthompo leemthompo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. I couldn't find anything that looked out of place in the linked previews :)

@shainaraskas shainaraskas merged commit 17111e1 into elastic:main Jan 6, 2025
6 checks passed
shainaraskas added a commit to shainaraskas/elasticsearch that referenced this pull request Jan 7, 2025
(cherry picked from commit 17111e1)

# Conflicts:
#	docs/reference/cat/nodeattrs.asciidoc
shainaraskas added a commit to shainaraskas/elasticsearch that referenced this pull request Jan 7, 2025
(cherry picked from commit 17111e1)

# Conflicts:
#	docs/reference/cat/nodeattrs.asciidoc
@shainaraskas
Copy link
Contributor Author

💚 All backports created successfully

Status Branch Result
8.x
8.17

Questions ?

Please refer to the Backport tool documentation

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 v8.17.1 v8.18.0 v9.0.0

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants