kubeapps icon indicating copy to clipboard operation
kubeapps copied to clipboard

Review and adapt existing Kubeapps documentation to comply with new guidelines

Open castelblanque opened this issue 2 years ago • 1 comments

Summary Review and adapt existing Kubeapps documentation to comply with new guidelines defined in #5019.

Background and rationale New guidelines for documentation have been added to Kubeapps in #5019 and PR #5020. This newly required way of writing may differ from the existing documentation.

Description This tasks consists in adapting/rewriting existing Kubeapps documentation to the new standard, for example: from Under the hood, kapp-controller will create... in this document about Carvel packages, to Internally, ``kapp-controller`` will create....

Acceptance criteria Documentation is rewritten meeting the new guidelines, where needed.

castelblanque avatar Jul 05 '22 10:07 castelblanque

Summary:

ppbaena avatar Aug 19 '22 11:08 ppbaena

Working on How-to guides:

The rest of the How-to guides will be updated on specific issues as the team is currently working on issues related to them.

ppbaena avatar Sep 28 '22 14:09 ppbaena

I've created specific issues for updating pending documentation to be updated and aligned to work in progress in different components (forms, multi-cluster, architecture, etc.).

ppbaena avatar Oct 19 '22 15:10 ppbaena