Document how to convert existing templates to CI components
Problem
As a user managing CI templates for my organization I would like to know what is the workflow and best practices to follow when converting templates to CI components.
Solution
Document how to convert templates used with various include
types (local
, project
, remote
, etc.) to use CI components. Documentation could include:
- How to replace CI env variables with
include:inputs
for passing dynamic data. - How to create a CI component and its catalog resource project.
- Best practices for writing good CI components (avoid some of the top-level keywords, take
stage
as input, etc.). - What a good README should contain.
- How to use semantic versioning for releases.
- Etc.
Edited by Fabio Pitino