Enhance and restructure AutoOps pages #3955
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…wajihaparvez/docs-content into enhance-and-restructure-autoops-section
Vale Linting ResultsSummary: 3 warnings, 24 suggestions found
|
| File | Line | Rule | Message |
|---|---|---|---|
| deploy-manage/monitor/autoops/autoops-sm-troubleshoot-firewalls.md | 84 | Elastic.DontUse | Don't use 'and/or'. |
| deploy-manage/monitor/autoops/autoops-sm-troubleshoot-firewalls.md | 118 | Elastic.Latinisms | Latin terms and abbreviations are a common source of confusion. Use 'using' instead of ' via '. |
| deploy-manage/monitor/autoops/autoops-sm-troubleshoot-firewalls.md | 149 | Elastic.Latinisms | Latin terms and abbreviations are a common source of confusion. Use 'using' instead of ' via '. |
💡 Suggestions (24)
| File | Line | Rule | Message |
|---|---|---|---|
| deploy-manage/monitor/autoops.md | 53 | Elastic.Wordiness | Consider using 'because' instead of 'since'. |
| deploy-manage/monitor/autoops.md | 55 | Elastic.Capitalization | 'How AutoOps is licensed' should use sentence-style capitalization. |
| deploy-manage/monitor/autoops.md | 57 | Elastic.Acronyms | 'ECU' has no definition. |
| deploy-manage/monitor/autoops.md | 65 | Elastic.Capitalization | 'What AutoOps monitors [ec_autoops_scope]' should use sentence-style capitalization. |
| deploy-manage/monitor/autoops/autoops-for-cloud-hosted.md | 12 | Elastic.Capitalization | 'AutoOps for ***' should use sentence-style capitalization. |
| deploy-manage/monitor/autoops/autoops-for-cloud-hosted.md | 18 | Elastic.FutureTense | 'you'll find' might be in future tense. Write in the present tense to describe the state of the product as it is now. |
| deploy-manage/monitor/autoops/autoops-sm-troubleshoot-firewalls.md | 25 | Elastic.Semicolons | Use semicolons judiciously. |
| deploy-manage/monitor/autoops/autoops-sm-troubleshoot-firewalls.md | 78 | Elastic.FutureTense | 'will return' might be in future tense. Write in the present tense to describe the state of the product as it is now. |
| deploy-manage/monitor/autoops/autoops-sm-troubleshoot-firewalls.md | 82 | Elastic.WordChoice | Consider using 'can, might' instead of 'may', unless the term is in the UI. |
| deploy-manage/monitor/autoops/autoops-sm-troubleshoot-firewalls.md | 86 | Elastic.WordChoice | Consider using 'can, might' instead of 'may', unless the term is in the UI. |
| deploy-manage/monitor/autoops/autoops-sm-troubleshoot-firewalls.md | 87 | Elastic.WordChoice | Consider using 'deactivate, deselect, hide, turn off' instead of 'Disable', unless the term is in the UI. |
| deploy-manage/monitor/autoops/autoops-sm-troubleshoot-firewalls.md | 87 | Elastic.Acronyms | 'XGET' has no definition. |
| deploy-manage/monitor/autoops/autoops-sm-troubleshoot-firewalls.md | 87 | Elastic.Acronyms | 'XGET' has no definition. |
| deploy-manage/monitor/autoops/autoops-sm-troubleshoot-firewalls.md | 92 | Elastic.FutureTense | 'will stop' might be in future tense. Write in the present tense to describe the state of the product as it is now. |
| deploy-manage/monitor/autoops/autoops-sm-troubleshoot-firewalls.md | 123 | Elastic.FutureTense | 'will attempt' might be in future tense. Write in the present tense to describe the state of the product as it is now. |
| deploy-manage/monitor/autoops/autoops-sm-troubleshoot-firewalls.md | 129 | Elastic.FutureTense | 'will use' might be in future tense. Write in the present tense to describe the state of the product as it is now. |
| deploy-manage/monitor/autoops/autoops-sm-troubleshoot-firewalls.md | 129 | Elastic.Acronyms | 'CSP' has no definition. |
| deploy-manage/monitor/autoops/autoops-sm-troubleshoot-firewalls.md | 129 | Elastic.Acronyms | 'CSP' has no definition. |
| deploy-manage/monitor/autoops/cc-cloud-connect-autoops-troubleshooting.md | 41 | Elastic.WordChoice | Consider using 'can, might' instead of 'may', unless the term is in the UI. |
| deploy-manage/monitor/autoops/ec-autoops-faq.md | 61 | Elastic.WordChoice | Consider using 'can, might' instead of 'may', unless the term is in the UI. |
| deploy-manage/monitor/autoops/ec-autoops-faq.md | 109 | Elastic.FirstPerson | Avoid first-person pronouns such as ' I '. |
| deploy-manage/monitor/autoops/ec-autoops-faq.md | 109 | Elastic.FirstPerson | Avoid first-person pronouns such as 'my'. |
| deploy-manage/monitor/autoops/use-autoops-in-sm-cluster.md | 17 | Elastic.Capitalization | 'Views in AutoOps' should use sentence-style capitalization. |
| deploy-manage/monitor/autoops/use-autoops-in-sm-cluster.md | 21 | Elastic.Capitalization | 'Events in AutoOps' should use sentence-style capitalization. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR restructures the AutoOps section + makes various general fixes. Most notably, I have:
Closes #3559 and #3220