Skip to content

Conversation

eedugon
Copy link
Contributor

@eedugon eedugon commented Sep 30, 2025

Solves elastic/docs-content#579

I've added some small improvements:

  • Introduction and link to the remote cluster server interface settings that are available in a different doc (network settings)-
  • Small intro in the network settings sub-section to also link to the remote cluster settings.

TBD:

  • The mapped_page is the same as the one in docs-content, we need to clarify that before merging.
  • 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?

cc: @shainaraskas

@elasticsearchmachine elasticsearchmachine added needs:triage Requires assignment of a team area label v9.2.0 labels Sep 30, 2025
Copy link
Contributor

github-actions bot commented Sep 30, 2025

Copy link
Contributor

ℹ️ 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 overview

When to use applies_to tags:

✅ At the page level to indicate which products/deployments the content applies to (mandatory)
✅ When features change state (e.g. preview, ga) in a specific version
✅ When availability differs across deployments and environments

What NOT to do:

❌ Don't remove or replace information that applies to an older version
❌ Don't add new information that applies to a specific version without an applies_to tag
❌ Don't forget that applies_to tags can be used at the page, section, and inline level

🤔 Need help?

@eedugon eedugon added >docs General docs changes Team:Docs Meta label for docs team labels Oct 1, 2025
@elasticsearchmachine elasticsearchmachine removed the needs:triage Requires assignment of a team area label label Oct 1, 2025
@elasticsearchmachine
Copy link
Collaborator

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

Copy link
Contributor

@shainaraskas shainaraskas left a 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!




## Advanced remote cluster (API key based model) settings [remote-cluster-network-settings]
Copy link
Contributor

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

Copy link
Contributor Author

@eedugon eedugon Oct 2, 2025

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.

Copy link
Contributor Author

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?

Copy link
Contributor

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

similar to https://www.elastic.co/docs/reference/elasticsearch/configuration-reference/data-stream-lifecycle-settings

Copy link
Contributor

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

@eedugon eedugon enabled auto-merge (squash) October 6, 2025 13:00
@eedugon eedugon merged commit f058fb1 into main Oct 6, 2025
12 checks passed
@eedugon eedugon deleted the remote_cluster_settings_from_docs_content branch October 6, 2025 13:10
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 v9.3.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants