-
Notifications
You must be signed in to change notification settings - Fork 25.5k
Remote clusters client settings moved from docs-content #135698
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
Conversation
ℹ️ Important: Docs version tagging👋 Thanks for updating the docs! Just a friendly reminder that our docs are now cumulative. This means all 9.x versions are documented on the same page and published off of the main branch, instead of creating separate pages for each minor version. We use applies_to tags to mark version-specific features and changes. Expand for a quick overviewWhen to use applies_to tags:✅ At the page level to indicate which products/deployments the content applies to (mandatory) What NOT to do:❌ Don't remove or replace information that applies to an older version 🤔 Need help?
|
Pinging @elastic/core-docs (Team:Docs) |
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'd double check the applies tags before merging. otherwise good
The mapped_page is the same as the one in docs-content, we need to clarify that before merging.
^ this is what we want. it controls backlinks into the old docs
Review and look for certain new settings that I believe are missing.
😍
Should we link from the remote cluster settings new document to the remote clusters narrative doc in docs-content? Or just the other way around?
yes, both, always. links always!
docs/reference/elasticsearch/configuration-reference/remote-clusters.md
Outdated
Show resolved
Hide resolved
|
||
|
||
|
||
## Advanced remote cluster (API key based model) settings [remote-cluster-network-settings] |
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.
this page has the following front matter:
---
mapped_pages:
- https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-network.html
applies_to:
deployment:
ess:
self:
---
I think the applies_to is wrong here (it either needs more or less)
without cross-referencing with the tutorials I am not sure which one
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.
Not totally sure how to address it. This doc is interesting because 80% of the settings are probably valid only for self-managed, but certain settings will definitely be available in ECK, ECE, and ECH.
For the moment I've left:
applies_to:
deployment:
ess:
self:
ece:
eck:
serverless: unavailable
And if you believe we should highlight anything in the text we can do it also, but I don't want the doc to feel overwhelming. Also it's not in the scope of this PR to analyze each setting and apply badges.
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.
forgot to ping you there @shainaraskas .
Let me know how you would like to address this.... ideally we should clarify the availability of each setting or each section, but all network settings are not in the scope of this PR.
Would you prefer to update the applies_to in the way I've done or would you prefer to keep the previous values?
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.
just switch it to stack
if all of the stack deployment types are in scope
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.
we'll need to refine this setting-by-setting but you're correct it's out of scope for this pr
Solves elastic/docs-content#579
I've added some small improvements:
TBD:
mapped_page
is the same as the one in docs-content, we need to clarify that before merging.cc: @shainaraskas