Skip to main content
Version: Next 🚧

Documentation organization

Kubewarden organizes project documentation as follows:

  • Introduction
  • Quick start
  • Tutorials — learning through examples.
  • Explanations — underlying concepts.
  • Howtos — getting Kubewarden tasks done.
  • Reference
  • Organization — this page
  • Personas — who is Kubewarden for?
  • Security
  • Glossary

Most of the material is in the four sections, Tutorials, Explanations, Howtos, and Reference. There may be overlap as the sections aren't mutually exclusive. The Kubewarden project tries to follow the Diátaxis documentation framework

The left hand contents menu always indicates your current document location. The right hand sections menu shows the current page sections. There is also a 'breadcrumbs' feature at the top of the main content panel on each page.

A search box facility is in the header panel of each page.

Editing​

A link to the page source on GitHub is at the bottom of each page.

Other resources​

Also maintained are:

  • RFCs for the project.
  • A series of blogposts largely related to Kubewarden releases.
  • Items related to the community management of Kubewarden.