[Umbrella Issue] TKG Docs required for Oct 4 TCE MVP launch

vmware-tanzu / tanzu-framework

Tanzu Framework provides a set of building blocks to build atop of the Tanzu platform and leverages Carvel packaging and plugins to provide users with a much stronger, more integrated experience than the loose coupling and stand-alone commands of the previous generation of tools.

Apache License 2.0

196 stars 193 forks source link

MUST-HAVE Community Checklist reqts:

[x] Contribution guidelines

[x] Should include "how to build from source" as well

[x] Common style guide to use for documentation

[x] Docs: Have a clear “Getting started” guide for contributors

[x] Windows, Mac, and Linux instructions for all client programs
[x] Updated Prerequisite/Platform support/compatibility sections

[x] Docs: Have a clear “Getting started” guide for users; In review

[x] Docs: Ensure that design and architecture documents are available

[x] code of conduct

[X] OWNERS file

[x] Sample issue templates — see

[x] published roadmap (could be GH project board like GitHub itself, Knative WGs, etc. use?)

[x] GOVERNANCE directive

[x] ADOPTERS file

[x] Maintainers file like example or can list them on the project landing page

[x] README

[x] list of features; @iancoffey
[x] include links to relevant outside sources

[x] Public API should have an accompanying programming guide

[x] Validate Release Notes Section in case there's been drift (here https://github.com/vmware-tanzu/tanzu-framework/blob/main/docs/release/release-notes-gathering-process.md) cc @vuil

[x] Updated Copyright information

[x] Validated external internal links

[x] Doc that explains how to select packages/channels, and related language. In staging.

[x] Doc that includes guidelines for when/what we reject—PRs and issues that are acceptable/will be accepted and not/won't. TCE also creating such a doc: here

Nice-to-have for TCE MVP launch

[ ] Docs explicitly highlighting the differences between Tanzu Framework + TCE. Source of truth should be vendored from Framework. TCE team would own, but Framework to review.

Not needed by TCE MVP launch—to be evaluated for inclusion post-launch

[ ] Include a reminder in docs "please look out for duplicates"; won't prevent them, but helps a bit.
[x] Bug priority/severity ranking doc. @carlisia drafting a matrix for TCE that Framework could fork/adapt.
[ ] Doc describing the labelling process and defining labels used
[ ] TCE creating a repo containing a set templates both projects can use.
[x] Include security.md file (see example and include button pointing folks to this policy via the Issues template menu
[ ] Published criteria for who can get write access to the repo, and who can't. How TCE handles: set up teams that represent subsets of the project, make them codeowners, and that gives them write access. Framework wants to get to that. @joshrosso is writing this up for TCE, and @iancoffey asked to review.

Docs potentially needed a few months post-launch

[ ] Docs about the features/enhancements process; TCE and Framework projects have decided that devising enhancements processes with prod readiness review, graduation criteria, etc. can be tabled for now
[ ] A concepts and definitions section and new terms included in Tanzu glossary
[ ] Day 2 operations documentation
[ ] At least 2 different scenarios discussing how the product/project would be used present in the documentation

vmware-tanzu / tanzu-framework

[Umbrella Issue] TKG Docs required for Oct 4 TCE MVP launch #166

MUST-HAVE Community Checklist reqts: