-
Notifications
You must be signed in to change notification settings - Fork 190
[Do not merge] Convert tabs that can be applies-switch #4429
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
base: main
Are you sure you want to change the base?
[Do not merge] Convert tabs that can be applies-switch #4429
Conversation
Vale Linting ResultsSummary: 2 warnings, 38 suggestions found
|
| File | Line | Rule | Message |
|---|---|---|---|
| troubleshoot/elasticsearch/troubleshoot-migrate-to-tiers.md | 29 | Elastic.BritishSpellings | Use American English spelling 'toward' instead of British English 'towards'. |
| troubleshoot/elasticsearch/troubleshoot-migrate-to-tiers.md | 116 | Elastic.BritishSpellings | Use American English spelling 'toward' instead of British English 'towards'. |
💡 Suggestions (38)
| File | Line | Rule | Message |
|---|---|---|---|
| deploy-manage/users-roles/cluster-or-deployment-auth/saml.md | 425 | Elastic.Acronyms | 'PEM' has no definition. |
| troubleshoot/elasticsearch/add-tier.md | 29 | Elastic.Wordiness | Consider using 'to' instead of 'In order to'. |
| troubleshoot/elasticsearch/add-tier.md | 74 | Elastic.Wordiness | Consider using 'to' instead of 'In order to'. |
| troubleshoot/elasticsearch/allow-all-cluster-allocation.md | 27 | Elastic.Wordiness | Consider using 'to' instead of 'In order to'. |
| troubleshoot/elasticsearch/allow-all-cluster-allocation.md | 81 | Elastic.Wordiness | Consider using 'to' instead of 'In order to'. |
| troubleshoot/elasticsearch/allow-all-index-allocation.md | 30 | Elastic.Wordiness | Consider using 'to' instead of 'In order to'. |
| troubleshoot/elasticsearch/allow-all-index-allocation.md | 83 | Elastic.Wordiness | Consider using 'to' instead of 'In order to'. |
| troubleshoot/elasticsearch/decrease-disk-usage-data-node.md | 55 | Elastic.Wordiness | Consider using 'to' instead of 'In order to'. |
| troubleshoot/elasticsearch/diagnose-unassigned-shards.md | 30 | Elastic.Wordiness | Consider using 'to' instead of 'In order to'. |
| troubleshoot/elasticsearch/diagnose-unassigned-shards.md | 146 | Elastic.Wordiness | Consider using 'to' instead of 'In order to'. |
| troubleshoot/elasticsearch/diagnosing-corrupted-repositories.md | 23 | Elastic.FutureTense | 'will entail' might be in future tense. Write in the present tense to describe the state of the product as it is now. |
| troubleshoot/elasticsearch/diagnosing-corrupted-repositories.md | 23 | Elastic.FutureTense | 'will keep' might be in future tense. Write in the present tense to describe the state of the product as it is now. |
| troubleshoot/elasticsearch/diagnosing-corrupted-repositories.md | 23 | Elastic.FutureTense | 'will be' might be in future tense. Write in the present tense to describe the state of the product as it is now. |
| troubleshoot/elasticsearch/diagnosing-corrupted-repositories.md | 60 | Elastic.FutureTense | 'will entail' might be in future tense. Write in the present tense to describe the state of the product as it is now. |
| troubleshoot/elasticsearch/fix-other-node-out-of-disk.md | 38 | Elastic.Wordiness | Consider using 'to' instead of 'In order to'. |
| troubleshoot/elasticsearch/fix-other-node-out-of-disk.md | 38 | Elastic.FutureTense | 'will need' might be in future tense. Write in the present tense to describe the state of the product as it is now. |
| troubleshoot/elasticsearch/high-jvm-memory-pressure.md | 45 | Elastic.Acronyms | 'JVM' has no definition. |
| troubleshoot/elasticsearch/increase-capacity-data-node.md | 21 | Elastic.Wordiness | Consider using 'to' instead of 'In order to'. |
| troubleshoot/elasticsearch/increase-capacity-data-node.md | 57 | Elastic.Wordiness | Consider using 'to' instead of 'In order to'. |
| troubleshoot/elasticsearch/increase-capacity-data-node.md | 57 | Elastic.FutureTense | 'will need' might be in future tense. Write in the present tense to describe the state of the product as it is now. |
| troubleshoot/elasticsearch/increase-cluster-shard-limit.md | 29 | Elastic.Wordiness | Consider using 'to' instead of 'In order to'. |
| troubleshoot/elasticsearch/increase-cluster-shard-limit.md | 81 | Elastic.Wordiness | Consider using 'to' instead of 'In order to'. |
| troubleshoot/elasticsearch/increase-shard-limit.md | 29 | Elastic.Wordiness | Consider using 'to' instead of 'In order to'. |
| troubleshoot/elasticsearch/increase-shard-limit.md | 82 | Elastic.Wordiness | Consider using 'to' instead of 'In order to'. |
| troubleshoot/elasticsearch/increase-tier-capacity.md | 27 | Elastic.FutureTense | 'will increase' might be in future tense. Write in the present tense to describe the state of the product as it is now. |
| troubleshoot/elasticsearch/increase-tier-capacity.md | 139 | Elastic.Wordiness | Consider using 'to' instead of 'In order to'. |
| troubleshoot/elasticsearch/repeated-snapshot-failures.md | 27 | Elastic.Wordiness | Consider using 'to' instead of 'In order to'. |
| troubleshoot/elasticsearch/restore-from-snapshot.md | 27 | Elastic.Wordiness | Consider using 'to' instead of 'In order to'. |
| troubleshoot/elasticsearch/restore-from-snapshot.md | 231 | Elastic.Wordiness | Consider using 'to' instead of 'In order to'. |
| troubleshoot/elasticsearch/troubleshoot-migrate-to-tiers.md | 29 | Elastic.Wordiness | Consider using 'to' instead of 'In order to'. |
| troubleshoot/elasticsearch/troubleshoot-migrate-to-tiers.md | 29 | Elastic.FutureTense | 'will resolve' might be in future tense. Write in the present tense to describe the state of the product as it is now. |
| troubleshoot/elasticsearch/troubleshoot-migrate-to-tiers.md | 29 | Elastic.FutureTense | 'will also' might be in future tense. Write in the present tense to describe the state of the product as it is now. |
| troubleshoot/elasticsearch/troubleshoot-migrate-to-tiers.md | 116 | Elastic.Wordiness | Consider using 'to' instead of 'In order to'. |
| troubleshoot/elasticsearch/troubleshoot-migrate-to-tiers.md | 116 | Elastic.FutureTense | 'will resolve' might be in future tense. Write in the present tense to describe the state of the product as it is now. |
| troubleshoot/elasticsearch/troubleshoot-migrate-to-tiers.md | 116 | Elastic.FutureTense | 'will also' might be in future tense. Write in the present tense to describe the state of the product as it is now. |
| troubleshoot/observability/apm/apm-server-response-codes.md | 20 | Elastic.WordChoice | Consider using 'refer to (if it's a document), view (if it's a UI element)' instead of 'See', unless the term is in the UI. |
| troubleshoot/observability/apm/apm-server-response-codes.md | 24 | Elastic.WordChoice | Consider using 'refer to (if it's a document), view (if it's a UI element)' instead of 'See', unless the term is in the UI. |
| troubleshoot/observability/troubleshoot-logs.md | 49 | Elastic.WordChoice | Consider using 'refer to (if it's a document), view (if it's a UI element)' instead of 'see', unless the term is in the UI. |
|
Edit: found ittttt |
…-leborgne/docs-content into convert-tabs-into-applies-switch
|
@florent-leborgne , what kind of reviews do you want on this? It's not the typical PR so I'm just thinking about how best to go about it 🕵️ |
shainaraskas
left a comment
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.
most of this looks good, but please skip the elasticsearch troubleshooting content. I'll need to fix it with the page-level issues
| #### Adaptive resources disabled | ||
|
|
||
| ::::{tab-set} | ||
| ::::{applies-switch} | ||
|
|
||
| :::{tab-item} ECH, ECE | ||
| :::{applies-item} { ess:, ece: } |
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 think a one-tab applies switch is an anti-pattern. this should be a tag on the section instead.
| * {applies_to}`serverless:` [Spaces API](https://www.elastic.co/docs/api/doc/serverless/operation/operation-get-spaces-space) | ||
| * {applies_to}`stack:` [Spaces API](https://www.elastic.co/docs/api/doc/kibana/operation/operation-post-spaces-copy-saved-objects) |
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 don't think this is a good case for applies tags because it's harder to read
|
|
||
| ::::{tab-set} | ||
| :group: ech-serverless-ece | ||
| ::::{applies-switch} |
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.
do these need to be ordered manually? we might want serverless here first
| :::{applies-item} serverless: | ||
| 1. Find your project on the home page or on the **Serverless projects** page, then select **Manage** to access its settings menus. | ||
| On the **Hosted deployments** page you can narrow your deployments by name, ID, or choose from several other filters. To customize your view, use a combination of filters, or change the format from a grid to a list. | ||
| 2. On the **Network security** page, find the policy that you want to disconnect. | ||
| 3. Under **Actions**, click the **Delete** icon. | ||
| ::: |
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 section being here is actually a bug. gonna have to remove it in another PR
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.
| deployment: | ||
| self: | ||
| eck: | ||
| ``` |
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.
| Once you know what you want to evaluate, choose the deployment option that best supports your goals. Elastic offers two primary deployment options on {{ecloud}}. | ||
|
|
||
| ::::{tab-set} | ||
| ::::{applies-switch} |
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.
don't like that this is tabbed but 🤷
| :::::: | ||
|
|
||
| ::::::{tab-item} Self-managed | ||
| ::::::{applies-item} self: |
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 think this is a case where self-managed is used as shorthand for ece eck self ... I can't be sure about this because I don't know how ECE handles this. maybe we need an issue to double-check this
| In order to allow indices to be allocated, follow these steps to add the [data tier](../../manage-data/lifecycle/data-tiers.md) the indices expect to be allocated on to your deployment: | ||
|
|
||
| :::::::{tab-set} | ||
| :::::::{applies-switch} |
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 one also feels wrong. consider leaving it alone
| In order to (re)allow all data to be allocated follow these steps: | ||
|
|
||
| :::::::{tab-set} | ||
| :::::::{applies-switch} |
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.
same with this one ... bet a lot of the troubleshooting ones will have this problem
|
as a side note, there's only maybe a handful of things in here with a range ... this could be split and most of it could be merged ASAP |

Summary
This PR converts tabs that should now be applies-switch thanks to the recent and upcoming updates to the metadata system.
This PR should only be merged after elastic/docs-builder#2322 is merged.
CI should fail until then.
Contributes to: #4361
Generative AI disclosure