techdocs icon indicating copy to clipboard operation
techdocs copied to clipboard

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

Open chalin opened this issue 4 years ago • 1 comments

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:
  2. CNCF website starter: contribute to the discussion, planning and creation of a starter, be it through either of the following:
  3. Documentation: contribute to documenting our website best-practices.
    • Related: https://github.com/cncf/techdocs/issues/54

chalin avatar Jul 28 '21 13:07 chalin

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.

chalin avatar Aug 11 '21 13:08 chalin