Skip to content

Conversation

@owenrumney
Copy link
Contributor

@owenrumney owenrumney commented Nov 13, 2025

Description

This PR restructures the docs a little to support the new hosting in
CloudFlare and breaking away the home page management to marketting
while retaining a workable docs site.

Key changes -

  • rename docs/docs to docs/guide as a path
  • rename Docs menu to User Guide
  • update the index in docs/guide to reflect the new name of User Guide
  • remove the assets that were for partner and home page
  • remove the partner page from the nav
  • update the links to point to guide rather than docs where applicable
  • update the mage file to remove the redunant CSS target
  • update the links in the the mage docs for specialist references files

Note

Home and Partners is rewritten during the deployment to CloudFlare from the rather empty docs/index.md to the root of the Marketting site

Related issues

Checklist

@owenrumney owenrumney marked this pull request as ready for review November 13, 2025 16:01
@knqyf263
Copy link
Collaborator

We probably need to update mkdocs.yml as Partners is still shown and returns 404.

image

@owenrumney
Copy link
Contributor Author

owenrumney commented Nov 17, 2025

We probably need to update mkdocs.yml as Partners is still shown and returns 404.
image

Partners is rewritten during the build in trivy-www. https://github.com/aquasecurity/trivy-www/blob/main/build/filter_nav.py#L7-L9

We can remove it entirely from the mkdocs if its not something we need in the actual docs?

If we remove the partners link from the docs, it removes a substantial amount of the preprocessing, so I'm all for it - @itaysk - do you have an opinion on partners link in the Docs area?

@knqyf263
Copy link
Collaborator

Home and Partners is rewritten during the deployment to CloudFlare from the rather empty docs/index.md to the root of the Marketting site

Oh, sorry I missed it. It seems more intuitive to keep MkDocs running on its own instead of returning a 404 for partners, and it might also be less confusing for external contributors (and even maintainers like me 😄 ), but I’m fine either way.

@owenrumney owenrumney force-pushed the docs/restructure-docs branch from 01497a8 to 8c65197 Compare November 17, 2025 10:38
@owenrumney
Copy link
Contributor Author

Home and Partners is rewritten during the deployment to CloudFlare from the rather empty docs/index.md to the root of the Marketting site

Oh, sorry I missed it. It seems more intuitive to keep MkDocs running on its own instead of returning a 404 for partners, and it might also be less confusing for external contributors (and even maintainers like me 😄 ), but I’m fine either way.

Don't worry, you didn't miss it, I added it to make it more clear :-D

I think removing it is probably best for the developer experience - if Itay wants it in the docs, it can be added at the trivy-www level.

I've updated the PR.

Copy link
Collaborator

@knqyf263 knqyf263 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Personally, I feel that the partner page doesn’t need to be included in the documentation, but since I don’t have a strong opinion about it, let’s hear what Itay thinks.

@nikpivkin
Copy link
Contributor

There are a couple more places where docs is still used:

This PR restructures the docs a little to support the new hosting in
CloudFlare and breaking away the home page management to marketting
while retaining a workable docs site.

Key changes -

- rename docs/docs to docs/guide as a path
- rename Docs menu to User Guide
- update the index in docs/guide to reflect the new name of User Guide
- remove the assets that were for partner and home page
- remove the partner page from the nav
- update the links to point to guide rather than docs where applicable
- update the mage file to remove the redunant CSS target
- update the links in the the mage docs for specialist references files
@owenrumney owenrumney force-pushed the docs/restructure-docs branch from 8c65197 to 9f0a018 Compare November 18, 2025 14:55
@owenrumney owenrumney added this pull request to the merge queue Nov 18, 2025
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Nov 18, 2025
@owenrumney owenrumney added this pull request to the merge queue Nov 18, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: restructure the docs for new hosting

3 participants