Planned / merged - Nephio: Porch Documentation

Short Description

Topic Overview

The Porch documentation is very fragmented. The following improvements are needed:

• Explain the lifecycle of repositories, packages, and package revisions

• Explain how Porch interacts with upstream repos

• Explain how Porch interacts with downstream repos

• Explain what a workspace is, see

• Document or remove WorkspaceName from porch PackageRevision spec #831

• Explain what the revision of a package revision is

• Explain the difference between initiating, copying, and cloning a package

• Explain how the update process of a package works

• Explain how the package mutation pipelines work and are triggered

• Explain the behaviour of packages which contain embedded packages

• Add better help on porchctl comands

• Add man pages for porchctl

• Explain the "latest" field works, and how it relates to the "latest" annotation

See Epic: Refactor the Porch documentation · Issue #727 · kptdev/porch and the wiki page Porch Documentation RefactoringPreview .

Session Type

Slides & Recording

Notes From Session (as appropriate)

Action Items (as appropriate)