-
Notifications
You must be signed in to change notification settings - Fork 2.8k
docs: restructure docs for new hosting #9799
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
Conversation
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? |
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. |
01497a8 to
8c65197
Compare
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. |
knqyf263
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.
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.
|
There are a couple more places where
|
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
8c65197 to
9f0a018
Compare


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 -
Note
Home and Partners is rewritten during the deployment to CloudFlare from the rather empty
docs/index.mdto the root of the Marketting siteRelated issues
Checklist