cncf / tag-security

🔐CNCF Security Technical Advisory Group -- secure access, policy control, privacy, auditing, explainability and more!
https://cncf.io/projects
Other
1.99k stars 496 forks source link

docs: Synchronizing top level content with website #1249

Closed eddie-knight closed 1 month ago

eddie-knight commented 1 month ago

See preview site to validate changes.

netlify[bot] commented 1 month ago

Deploy Preview for tag-security ready!

Name Link
Latest commit b6455e5712e95ffa8c80693b148b06a75fe7b5b4
Latest deploy log https://app.netlify.com/sites/tag-security/deploys/664b91152707d10008f9c5b2
Deploy Preview https://deploy-preview-1249--tag-security.netlify.app
Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

eddie-knight commented 1 month ago

Linters are crying because of the self-assessment I had to touch to get the build working 🤣 Not sure whether it's worse practice to add a full lint of that otherwise-unrelated file to this review, or to ignore the linters.

eddie-knight commented 1 month ago

split off the linting so that it doesn't crowd this PR.

blocked by #1252

eddie-knight commented 1 month ago

Checks are all passing now.

Before we merge, I've requested input from @brandtkeller regarding the approach here

eddie-knight commented 1 month ago

Clicking through right now, I've noticed that there is still an issue loading the README links that are directly targeted. Here's my first thoughts...

Option 1: figure out a way to put the README files into the content directory without duplicating the content in the UI sidebar Option 2: figure out how to make the README links route to the _index pages to prevent duplication Option 3: decide that the duplication doesn't matter. Put the README in the sidebar as well as the _index. Option 4: Modify any content entries that target a README, and have them target the page root instead (on GitHub this will load the README, on Hugo this will load the _index)

eddie-knight commented 1 month ago

Just made a push incorporating Option#2 above