Part 1: Update docs for cloud nav redesign - #8192
Conversation
Elastic Docs AI PR menuCheck the box to run an AI review for this pull request.
Powered by GitHub Agentic Workflows and docs-actions. For more information, reach out to the docs team. |
Elastic Docs Style Checker (Vale)Summary: 4 warnings found
|
| File | Line | Rule | Message |
|---|---|---|---|
| deploy-manage/api-keys/elastic-cloud-api-keys.md | 53 | Elastic.MenuArrowsBold | Use '→' to separate menu items, not '' or '='. Example: Select Manage index → Add lifecycle policy. |
| deploy-manage/api-keys/elastic-cloud-api-keys.md | 107 | Elastic.MenuArrowsBold | Use '→' to separate menu items, not '' or '='. Example: Select Manage index → Add lifecycle policy. |
| deploy-manage/cloud-organization/billing/update-billing-operational-contacts.md | 26 | Elastic.MenuArrowsBold | Use '→' to separate menu items, not '' or '='. Example: Select Manage index → Add lifecycle policy. |
| manage-data/ingest/ingesting-data-from-applications/ingest-data-with-python-on-elasticsearch-service.md | 83 | Elastic.MenuArrows | Use '→' to separate menu items, not '' or '='. Example: Select Manage index → Add lifecycle policy. |
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.
nastasha-solomon
left a comment
There was a problem hiding this comment.
Left a few suggestions for your consideration. Otherwise, lgtm!
| ::::{tab-set} | ||
| :::{tab-item} Using the {{ecloud}} Console | ||
| 1. Log in to the [{{ecloud}} Console](https://cloud.elastic.co?page=docs&placement=docs-body). | ||
| 2. Go to your avatar in the upper right corner and choose **Organization**. |
There was a problem hiding this comment.
If this instruction is still relevant to users on earlier versions of the stack, add applies_to tag. Looks like there's a handful of similar instances across this PR, so flagging it here instead of dropping individual comments throughout.
| 1. Log in to the [{{ecloud}} Console](https://cloud.elastic.co?page=docs&placement=docs-body). | ||
| 2. Go to your avatar in the upper right corner and choose **Organization**. | ||
| 3. On the **API keys** tab of the **Organization** page, click **Create API key**. | ||
| 2. From the navigation menu, select **Organization** > **API keys**. |
There was a problem hiding this comment.
Directing users towards the global search bar is also a good strategy for future-proofing nav-related content. I entered "API keys" into the search bar for a stack deployment and serverless project, and got the same result for both.
Here's one option:
| 2. From the navigation menu, select **Organization** > **API keys**. | |
| 2. From the navigation menu, select **Organization** → **API keys**. You can also search for **API keys** in the [global search bar](/explore-analyze/find-and-organize/find-apps-and-objects.md). |
Another, more succint version:
| 2. From the navigation menu, select **Organization** > **API keys**. | |
| 2. Search for **API keys** in the [global search bar](/explore-analyze/find-and-organize/find-apps-and-objects.md). |
| In {{kib}}, go to **Agent Builder** → **Tools library**, click **Manage MCP**, and select **Manage MCP clients (OAuth)** to confirm the connection count for your client has increased. If you don't see it within a minute of authorizing, refresh the page. | ||
|
|
||
| You can also check your connection in the {{ecloud}} Console at **Organization** → **Security settings** → **Application connections**. | ||
| You can also check your connection in the {{ecloud}} Console at **Organization** → **Application connections**. |
There was a problem hiding this comment.
Same rec to refer users towards the global search bar.
georgewallace
left a comment
There was a problem hiding this comment.
Minor nits and questions.
| @@ -1,2 +1,2 @@ | |||
| 1. Log in to [{{ecloud}}](https://cloud.elastic.co?page=docs&placement=docs-body). | |||
| 2. From the navigation menu, select **Security** > **Network security**. No newline at end of file | |||
| 2. From the navigation menu, select **Organization** > **Network security**. No newline at end of file | |||
There was a problem hiding this comment.
is this line supposed to be different then the steps in deploy-manage/deploy/elastic-cloud/azure-native-isv-service-troubleshooting.md
| ### Basic authentication [ec_basic_authentication] | ||
|
|
||
| For basic authentication, use the same deployment credentials (`username` and `password` parameters) and Cloud ID you copied down earlier when you created your deployment. (If you did not save the password, you can [reset the password](../../../deploy-manage/users-roles/cluster-or-deployment-auth/built-in-users.md) .) | ||
| For basic authentication, use the same deployment credentials (`username` and `password` parameters) and Cloud ID you copied down earlier when you created your deployment. (If you did not save the password, you can [reset the password](../../../deploy-manage/users-roles/cluster-or-deployment-auth/built-in-users.md).) |
There was a problem hiding this comment.
you renamed this link in other pages but not this one. Was this expected?
| ### Basic authentication [ec_basic_authentication_2] | ||
|
|
||
| For basic authentication, use the same deployment credentials (`username` and `password` parameters) and Cloud ID you copied down earlier. Find your Cloud ID by going to the {{kib}} main menu and selecting Management > Integrations, and then selecting View deployment details. (If you did not save the password, you can [reset the password](../../../deploy-manage/users-roles/cluster-or-deployment-auth/built-in-users.md) .) | ||
| For basic authentication, use the same deployment credentials (`username` and `password` parameters) and Cloud ID you copied down earlier. Find your Cloud ID by going to the {{kib}} main menu and selecting Management > Integrations, and then selecting View deployment details. (If you did not save the password, you can [reset the password](../../../deploy-manage/users-roles/cluster-or-deployment-auth/built-in-users.md).) |
There was a problem hiding this comment.
you renamed this link in other pages but not this one. Was this expected?
Summary
Updates docs to reflect new nav changes in cloud UI.
Rel docs issue: https://github.com/elastic/docs-content-internal/issues/1766
Side nav reorg
Lots of items in the nav moved around to new sections (listed here). In most cases, I opted to exclude subsections and just document the
top-level section > target page(e.g. Organization> Identity and access> Members) to future-proof in case subsections are moved again. The subsections are not clickable in the UI anyway.Rel cloud UI PR: https://github.com/elastic/cloud-ui/pull/4127
Reset password path (ECH and ECE)
Previously, users could reset their password from their deployment's Security page or Overview > Actions menu. The Security path is going away now.
Rel cloud UI PR: https://github.com/elastic/cloud-ui/pull/4279
Bonus
I found a bunch of ECH/ECE “reset the password” links that pointed to the self-managed built-in users page, which then directed cloud users to the ECH/ECE page (2 steps later). Fixed to point to the ECH/ECE page directly.
Generative AI disclosure