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

Review and adapt existing Kubeapps documentation to comply with new guidelines #5024

Closed
castelblanque opened this issue Jul 5, 2022 · 3 comments
Assignees
Labels
component/project (To be removed) kind/documentation An issue that reports an update related to project documentation

Comments

@castelblanque
Copy link
Collaborator

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.

@kubeapps-bot kubeapps-bot moved this to 🗂 Backlog in Kubeapps Jul 5, 2022
@castelblanque castelblanque added the kind/documentation An issue that reports an update related to project documentation label Jul 5, 2022
@castelblanque castelblanque added this to the Technical debt milestone Jul 5, 2022
@ppbaena ppbaena moved this from 🗂 Backlog to 🗒 Todo in Kubeapps Jul 15, 2022
@ppbaena ppbaena self-assigned this Jul 15, 2022
@ppbaena ppbaena moved this from 🗒 Todo to 🏗 In Progress in Kubeapps Aug 1, 2022
@ppbaena
Copy link
Collaborator

ppbaena commented Aug 19, 2022

@ppbaena
Copy link
Collaborator

ppbaena commented Sep 28, 2022

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
Copy link
Collaborator

ppbaena commented Oct 19, 2022

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 ppbaena closed this as completed Oct 20, 2022
Repository owner moved this from 🔎 In Review to ✅ Done in Kubeapps Oct 20, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component/project (To be removed) kind/documentation An issue that reports an update related to project documentation
Projects
Archived in project
Development

No branches or pull requests

2 participants