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

Documentation improvements as per CNCF recommendations #477

Open
7 tasks
jhkrug opened this issue Dec 17, 2024 · 0 comments
Open
7 tasks

Documentation improvements as per CNCF recommendations #477

jhkrug opened this issue Dec 17, 2024 · 0 comments
Assignees
Labels
area/documentation Improvements or additions to documentation kind/epic

Comments

@jhkrug
Copy link
Contributor

jhkrug commented Dec 17, 2024

As per CNCF recommendations report.

This issue lays out the needed/suggested tasks:

Specific

  • Documentation layout description page #485
  • Provide a page with a description of personas using and developing Kubewarden, at whom the documentation is aimed.
  • Kubewarden what is/introduction page review
    • New user section. If you are new to KW ... blah, blah.
    • Core features and benefits. What problem(s) does KW solve? The value proposition?
    • Link to and review/improve the explanation/architecture (referred to as the 'Overview' in the CNCF critique) page
    • Provide a recent developments and future roadmap section. Possibly point to an additional page.
  • Quick start page review
    • Link to the improved architecture document to provide context
    • Where can KW be installed? On prem? Cloud? Well, it's really wherever your K8s clusters are
    • Helm charts and their role in installation. More context and links to further information
    • Better description of prerequisites and their configuration
    • Common issues and errors
    • Validate copy/paste installation of basic installation on basic K8S. How deep to go?
    • Review main components section
    • Format and legal value for attributes table.
    • Further worked examples for differing scenarios?
  • New main docs section 'Policy management (& development)'?
    • Management
    • Development tutorials (Rust, etc.)

General

  • Review for active voice
  • Style guide consistency, currently Microsoft(y), but SUSE docs have their own style guide. Which is quite different.
@jhkrug jhkrug added area/documentation Improvements or additions to documentation kind/epic labels Dec 17, 2024
@jhkrug jhkrug self-assigned this Dec 17, 2024
@jhkrug jhkrug moved this to Todo in Kubewarden Dec 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/documentation Improvements or additions to documentation kind/epic
Projects
Status: Todo
Development

No branches or pull requests

1 participant