Skip to content
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

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

Open
Tracked by #116
chalin opened this issue Jul 28, 2021 · 1 comment
Open
Tracked by #116
Assignees
Labels
e3-weeks Effort: < 4 weeks p2-medium
Milestone

Comments

@chalin
Copy link
Collaborator

chalin commented Jul 28, 2021

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.
@chalin chalin added this to the 21Q3 milestone Jul 28, 2021
@chalin chalin self-assigned this Jul 28, 2021
@chalin
Copy link
Collaborator Author

chalin commented Aug 11, 2021

Although @caniszczyk recently gave a thumbs up to using Docsy (cncf/hugo-netlify-starter#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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
e3-weeks Effort: < 4 weeks p2-medium
Projects
None yet
Development

No branches or pull requests

1 participant