Skip to content

Documentation improvements as per CNCF recommendations #477

@jhkrug

Description

@jhkrug

As per CNCF recommendations report.

This issue lays out the needed/suggested tasks:

Specific

  • Documentation layout description page and personas page. #485

  • Who is the documentation for, what do they get?

  • Kubewarden what is/introduction page review

    • New user section. If you are new to KW ... blah, blah. CNCF recommendation - New to Kubewarden. #526
    • Core features and benefits. What problem(s) does KW solve? The value proposition? Sub-issue KW value proposition - CNCF #529
    • 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 CNCF recommendation - New to Kubewarden. #526
    • 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. Mention, but probably in a new linked page.
    • Further worked examples for differing scenarios?
  • New main docs section 'Policy management (& development)'?

    • Management
    • Development tutorials (Rust, etc.)

General

Sub-issues

Metadata

Metadata

Assignees

Labels

Type

No type

Projects

Status

Todo

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions