cncf / techdocs

CNCF TechDocs Team
https://www.cncf.io
Apache License 2.0
41 stars 26 forks source link

Tech docs website best-practices: reference-implementation design & maintenance #55

Open chalin opened 3 years ago

chalin commented 3 years ago

Evolving, documenting and demonstrating CNCF tech-docs website best-practices through reference-implementation design & maintenance, as well as techdocs documentation.

  1. Reference implementations: design and implement website infrastructure / best-practices in "reference-implementation" websites that have recently been reworked by the team:
chalin commented 3 years ago

Although @caniszczyk recently gave a thumbs up to using Docsy (https://github.com/cncf/hugo-netlify-starter/issues/64), as an alternative to migrating the hugo-netlify-starter to Docsy we should consider building on / customizing the docsy-example, which is already setup as a GitHub template.

I've updated the task breakdown in the original comment to reflect this possibility.

/cc @nate-double-u, since we discussed some of the details recently.