search

NASA-AMMOS / slim

Software Lifecycle Improvement & Modernization
https://nasa-ammos.github.io/slim/
Apache License 2.0
24 stars 9 forks source link

[Improve Existing Best Practice Guide]: Improve README for Continuous Integration to provide documentation guidance #125

Open jpl-jengelke opened 7 months ago

jpl-jengelke commented 7 months ago

Checked for duplicates

Yes - I've already checked

Best Practice Guide

Continuous Integration

Best Practice Guide Sections

No response

Describe the improvement

The README for Continuous Integration should be a launching point for using the Best practice Guide. In this regard, it should provide explanations of the various sub-sections and what they mean for implementing CI across an application. It should clarify what the sections are used for and what they represent.

riverma commented 6 months ago

Great idea @jpl-jengelke - might be good to see if there's a way, using Docusaurus, to auto-generate a good page for folder sections like the README for CI. Typically, pages like this should just list out the guides available and provide some basic introduction.