Documentation organization

SUSE Security Admission Controller organizes project documentation as follows:

  • Introduction

  • Quick start

  • Tutorials—learning through examples.

  • Explanations—underlying concepts.

  • Howtos—getting Admission Controller tasks done.

  • Reference

  • Organization—this page

  • Personas—who is Admission Controller for?

  • Security

  • Glossary

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

Navigation

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.

Search

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 blog posts related to Kubewarden releases.

  • Items related to the community management of Kubewarden.