Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
jpl-jengelke opened this issue Nov 16, 2023 · 1 comment
Assignees
Labels
information sharing Process improvements involving documentation, training, guides, communication, etc low complexity Ticket is relatively easy & straightforward to resolve

Comments

@jpl-jengelke
Copy link
Contributor

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.

@jpl-jengelke jpl-jengelke self-assigned this Nov 16, 2023
@jpl-jengelke jpl-jengelke added low complexity Ticket is relatively easy & straightforward to resolve information sharing Process improvements involving documentation, training, guides, communication, etc labels Nov 16, 2023
@riverma
Copy link
Collaborator

riverma commented Dec 8, 2023

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.

@jpl-jengelke jpl-jengelke assigned ingyhere and unassigned jpl-jengelke Sep 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
information sharing Process improvements involving documentation, training, guides, communication, etc low complexity Ticket is relatively easy & straightforward to resolve
Projects
None yet
Development

No branches or pull requests

3 participants