tag-security icon indicating copy to clipboard operation
tag-security copied to clipboard

docs: Synchronizing top level content with website

Open eddie-knight opened this issue 1 year ago • 4 comments
trafficstars

  • Navbar now populates from included content directories
  • Markdown files in included directories now populate as sub-pages within that section
  • "Edit this on Github" now links auto-populated files to the correct corresponding location

See preview site to validate changes.

eddie-knight avatar May 06 '24 02:05 eddie-knight

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.

netlify[bot] avatar May 06 '24 02:05 netlify[bot]

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 avatar May 06 '24 03:05 eddie-knight

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

blocked by #1252

eddie-knight avatar May 06 '24 21:05 eddie-knight

Checks are all passing now.

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

eddie-knight avatar May 08 '24 20:05 eddie-knight

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 avatar May 20 '24 16:05 eddie-knight

Just made a push incorporating Option#2 above

eddie-knight avatar May 20 '24 18:05 eddie-knight