edu icon indicating copy to clipboard operation
edu copied to clipboard

Published 20 hours ago • verified publisher icon chainguard-dev

Improve Enforce docs structure

Open kimsterv opened this issue 2 years ago • 2 comments

Consider splitting the Enforce docs into sections:

  • Enforce overview and architecture maybe
    • Signing images, creating sboms
      • Link to sigstore projects and docs
      • Using signing keys vs. keyless
    • Cli vs web
    • Agent vs. agentless
    • Runtime enforcement vs continuous
    • IAM, groups, invite codes
  • Getting started with enforce
    • Prereqs / compatible k8s distros, versions, etc.
    • Signing up
    • Signing your images, making sboms
    • Setting up chainctl
    • Sample policies
    • Applying policies to cluster
    • Viewing logs
  • Chainctl CLI detailed docs. Why do i need this and what does it do that i can’t do with kubectl
  • Enforce web UI detailed docs - what do i use this for?
  • Separately, quickstart tutorial

kimsterv avatar Sep 15 '22 20:09 kimsterv

Were you thinking these as separate docs? I think we have a number of these on the roadmap but I'll make sure to capture additional ones and capturing proposed headings.

ltagliaferri avatar Sep 16 '22 13:09 ltagliaferri

cc @amdawson as this was feedback from him.

kimsterv avatar Sep 16 '22 15:09 kimsterv

All the items listed are either published or in flight with their own tickets, so I will close this out.

ltagliaferri avatar Jan 20 '23 05:01 ltagliaferri