Kubernetes best practices v2

[weibeld]

Features for v2 of the production best practices checklist

1. Uniform structure for all items
   • Proposal: What?, Why?, How?, References
   • Makes it easier to comprehend items (and easier to write them)
2. Organise items by tags
   • No hardcoded categories. Makes it easier to discover items, but also to add items: no need to decide which category to add an item to, just add the item and assign it a set of relevant tags.
3. Incremental search
   • Incremental search that displays matching items as the search term is typed.
   • Search based on title, content, and possibly tags (if the tag-based organisation is implemented)
4. Tag selection
   • Display all available tags and allow to filter out the items matching one or more selected tag (if the tag-based organisation is implemented)
5. Table of contents
   • If not using a tab-based system, include a table of contents with all items
   • Example: https://webconverger.com/faq/
   • Could also be used with a tag-based system to give a concise overview of the currently selected items

[kaihendry]

Btw I generate the table of contents with https://github.com/kaihendry/toc using a Makefile. #oldskool

[weibeld]

Transferred to the kubernetes-production-best-practices repository.