search

elastic / security-docs

Elastic Security Documentation
Other
66 stars 179 forks source link

[DOCS IA] Remove technical preview section #5712

Closed benironside closed 1 week ago

benironside commented 3 weeks ago

UPDATE 8/30: We are going to keep the Troubleshooting section for now. Updating the action items.

Description

As part of the Sec Docs IA meta issue, remove the Technical preview sections from the ESS docs IA.

These changes are described in the IA outline:

Which documentation set does this change impact?

ESS only

ESS release

8.14

Serverless release

As soon as possible.

nastasha-solomon commented 2 weeks ago

The CI checks in 5747 failed and returned the following message after I deleted the Elastic Security troubleshooting page from the Security docs:

INFO:build_docs:Bad cross-document links:
--
  | INFO:build_docs:  /tmp/docsbuild/target_repo/html/en/starting-with-the-elasticsearch-platform-and-its-solutions/master/troubleshooting-and-faqs.html contains broken links to:
  | INFO:build_docs:   - en/security/master/troubleshooting-ov.html

It appears the Security page is referenced from the Troubleshooting and FAQs page in the Starting with the Elasticsearch Platform and its Solutions docset. Removing the "Elastic Security troubleshooting" page in the Security docs breaks that reference.

To resolve this issue, we can do the following:

  1. Go to the tech-content repo, open a PR against the troubleshooting-and-faqs.asciidoc file to remove the Security docs page reference, and merge the PR.
  2. Go back to https://github.com/elastic/security-docs/pull/5747, and enter run docs-build rebuild as a comment in the PR. This will rebuild the PR and all other Elastic docs.
  3. Confirm all the CI checks pass, complete the remaining tasks outlined in the description for 5712, and merge 5747.
  4. Go back to the tech-content repo, open a PR against the troubleshooting-and-faqs.asciidoc file, and add references to the following pages:

On a final note, I'm glad the CI checks caught the cross-repo link that would've broke because it relied on the "Elastic Security troubleshooting" page existing in the Security docset. But now I'm wondering if the CI checks are missing any other references to the Security page from other docsets. AFAIK, there's no quick and easy way to manually check this. It's just something to consider before merging 5747.nd

nastasha-solomon commented 2 weeks ago

Removing reference to page:

nastasha-solomon commented 1 week ago

Closing this issue since we're no longer removing the "Troubleshooting" section and because the "Technical preview" section was already removed for 8.15 and 8.16.