Update the Connect to a remote cluster page #4682
Conversation
yetanothertw
added
documentation
✅ Vale Linting ResultsNo issues found on modified lines! The Vale linter checks documentation changes against the Elastic Docs style guide. To use Vale locally or report issues, refer to Elastic style guide for Vale. |
…nding on their deployment type
shainaraskas
left a comment
shainaraskas
left a comment
There was a problem hiding this comment.
ultimately, I think that this ccr tutorial should just be one page, so this specific fix is not ideal in the long term. however, it fixes the root cause of the issue and is good enough for me.
some link syntax suggestions, and some suggestions on the remaining content scope. approving to unblock but you should edit a bit
| Find detailed instructions on the available options for your specific scenario: | ||
| * [](/deploy-manage/remote-clusters/remote-clusters-self-managed.md#add-remote-clusters) | ||
| * [](/deploy-manage/remote-clusters/ec-enable-ccs.md#set-up-remote-clusters-ech) | ||
| * [](/deploy-manage/remote-clusters/ece-enable-ccs.md#set-up-remote-clusters-ece) | ||
| * [](/deploy-manage/remote-clusters/eck-remote-clusters-landing.md#eck-rcs-setup) |
There was a problem hiding this comment.
these look wonky because you're linking to anchors. looking over these, I think linking further down the page makes the target harder to understand so i'd just simplify this so the titles are cuter
| Find detailed instructions on the available options for your specific scenario: | |
| * [](/deploy-manage/remote-clusters/remote-clusters-self-managed.md#add-remote-clusters) | |
| * [](/deploy-manage/remote-clusters/ec-enable-ccs.md#set-up-remote-clusters-ech) | |
| * [](/deploy-manage/remote-clusters/ece-enable-ccs.md#set-up-remote-clusters-ece) | |
| * [](/deploy-manage/remote-clusters/eck-remote-clusters-landing.md#eck-rcs-setup) | |
| Find detailed instructions on the available options for your specific scenario: | |
| * [](/deploy-manage/remote-clusters/remote-clusters-self-managed.md) | |
| * [](/deploy-manage/remote-clusters/ec-enable-ccs.md) | |
| * [](/deploy-manage/remote-clusters/ece-enable-ccs.md) | |
| * [](/deploy-manage/remote-clusters/eck-remote-clusters-landing.md) |
|
|
||
| :::: | ||
|
|
||
| To connect to a remote cluster, you consider the preferred [security model](/deploy-manage/remote-clusters/security-models.md) to use for authenticating remote connections between clusters, choose a [connection mode](/deploy-manage/remote-clusters/connection-modes.md), and depending on where the cluster you want to use as remote is hosted, you configure its connection address. |
There was a problem hiding this comment.
I think this paragraph is a little confusing and noisy, because it is getting a little into instructions that are not necessarily true (the "connection address" means different things in different contexts and might make people scratch their heads ... the tutorials will clarify everything through)
security models and connection modes are not necessarily upfront concerns either (they're kind of tied to your stack version, or there are smart defaults depending on your deployment type)
tl;dr throw them right into tutorial land. tell them the process depends on both their local and remote cluster type, and to select the category based on the "local cluster" they're configuring.
this is a simple similar thing https://docs-v3-preview.elastic.dev/elastic/docs-content/pull/4682/deploy-manage/remote-clusters#setup
Summary
Fixes #3473
These changes update the purpose of the page from what used to be a self-managed guide to a landing page that instead links out to instructions for setting up remote clusters for different deployment types.
A preview of the updated page
Generative AI disclosure