Skip to content
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

[Docs IA][8.15 & 8.16] Remove troubleshooting section #5747

Closed
wants to merge 4 commits into from

Conversation

nastasha-solomon
Copy link
Contributor

@nastasha-solomon nastasha-solomon commented Aug 23, 2024

Fixes #5712 by removing the "Troubleshooting" section from the TOC. As part of this cleanup, I also did the following:

  • Relocated images used in troubleshooting topics to their appropriate folders. For example, all of the images in the docs for troubleshooting exceptions were moved to the detections/images folder.
  • Renamed the "Detection rules" troubleshooting topic to "Troubleshoot detection rules"
  • Deleted the troubleshooting-intro.asciidoc file and the troubleshooting folder in our docs dir
  • Removed the include of the troubleshooting-intro.asciidoc file in the main TOC's index file

Preview:

Copy link

A documentation preview will be available soon.

Request a new doc build by commenting
  • Rebuild this PR: run docs-build
  • Rebuild this PR and all Elastic docs: run docs-build rebuild

run docs-build is much faster than run docs-build rebuild. A rebuild should only be needed in rare situations.

If your PR continues to fail for an unknown reason, the doc build pipeline may be broken. Elastic employees can check the pipeline status here.

@nastasha-solomon
Copy link
Contributor Author

The reason why the CI checks for this PR failed and a possible solution: #5712 (comment)

@nastasha-solomon
Copy link
Contributor Author

run docs-build rebuild

@nastasha-solomon nastasha-solomon changed the title [Docs IA][ESS] Remove troubleshooting section [Docs IA][8.15 & 8.16] Remove troubleshooting section Aug 27, 2024
@nastasha-solomon
Copy link
Contributor Author

Closing this PR as we've decided to keep the Troubleshooting section.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[DOCS IA] Remove technical preview section
1 participant