Fix applies_to in 2 troubleshooting documents: snapshot failures and restore from snapshot #4487
Conversation
Removed unnecessary deployment types from the document.
✅ 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. |
🔍 Preview links for changed docs |
eedugon
changed the title
eedugon
changed the title
yetanothertw
left a comment
yetanothertw
left a comment
There was a problem hiding this comment.
Looks good; I think there are a few ways in which we can simplify the pages further by removing a lot of the duplicated content. Let me know what you think.
| 2. The policies table should be visible. Click on any of the policies to review the details and execution history. | ||
|
|
||
| 3. Open your deployment’s side navigation menu (placed under the Elastic logo in the upper left corner) and go to **Dev Tools > Console**. | ||
| 3. To get more detailed information about the failure, open {{kib}} **Dev Tools > Console**. You can find the **Console** using the navigation menu or the [global search field](/explore-analyze/find-and-organize/find-apps-and-objects.md). |
There was a problem hiding this comment.
In other Troubleshooting pages where a similar approach was used (telling users to use Console), we separated out the common steps to only list them once. Step 4. in the Kibana tab is the exact same step as the one in the API tab.
Maybe we could remove it from the Kibana tab and in the API tab, you can add a statement to say something like:
You can run the following steps using either [API console](/explore-analyze/query-filter/tools/console.md) or direct [Elasticsearch API](elasticsearch://reference/elasticsearch/rest-apis/index.md) calls.
There was a problem hiding this comment.
yes, definitely. I'll update the tabs to remove content duplication.
|
|
||
| ::::::{tab-item} {{ech}} | ||
| In order to restore the indices and data streams that are missing data: | ||
| ::::::{tab-item} Using {{kib}} |
There was a problem hiding this comment.
I think we can remove this tab as it just repeats the same steps as in the API tab. It's sufficient to mention that you can run these steps in the console or as direct API calls, but the steps themselves are identical. (Actually there's tiny language differences which makes it look even worse, as it they're drifting over time).
There was a problem hiding this comment.
I completely agree. I just didn't want to lose time on this, as the scope of this activity was to just fix the applies_to tag, and we have similar issues in multiple other docs on the troubleshooting area. But I'll change it :)
Co-authored-by: Vlada Chirmicci <[email protected]>
|
@yetanothertw , thanks for your review. I've applied some changes plus refined the intro of the restore related document (to make it fit better the |
yetanothertw
left a comment
yetanothertw
left a comment
There was a problem hiding this comment.
Thanks, Edu! LGTM 👍
Removed unnecessary deployment types from the document.
Updated tabs for alignment with https://www.elastic.co/docs/troubleshoot/elasticsearch/diagnosing-corrupted-repositories and other examples we have recently updated (cc: @shainaraskas ).
I've refined the text a bit also for the Using Kibana use case.
The following doc has also been updated, with minor changes. This one still needs a lot of love from content point of view but we will improve it in a different PR: https://www.elastic.co/docs/troubleshoot/elasticsearch/restore-from-snapshot