Skip to content

Restructure design docs of CI components and catalog

Fabio Pitino requested to merge docs/fp-restructure-components-docs into master

What does this MR do and why?

In this MR we are restructuring the sections of the design doc for CI Components and Catalog by having a more nested structure. In a separate MR we will extract those major sections (CI Component, Inputs and CI Catalog) into separate sub-pages.

No content has been removed, only moved around.

Screenshots or screen recordings

Top level sections only:

Before After
  • Summary
  • Goals
  • Challenges
  • Opportunities
  • Glossary
  • Definition of pipeline component
  • Structure of a component
  • Components repository
  • spec:inputs parameters
  • CI Catalog
  • Catalog resource
  • Releasing new resource versions to the Catalog
  • Note about future resource types
  • Implementation guidelines
  • Iterations
  • Limits
  • Who
  • Summary
  • Challenges
  • Opportunities
  • Glossary
  • CI component
  • Input parameters
  • Components repository
  • CI Catalog
  • Implementation guidelines
  • Iterations
  • Limits
  • Who

MR acceptance checklist

This checklist encourages us to confirm any changes have been analyzed to reduce risks in quality, performance, reliability, security, and maintainability.

Edited by Grzegorz Bizon

Merge request reports