nebari-dev / nebari-dev/nebari-docs
[DOC] - Document CI workflows
Open
Nobody has claimed this yet.
area: community 🪴
area: documentation 📖
type: enhancement 💅🏼
- Dominant language
- No language data
- Stars
- 21
- Forks
- 40
- Avg merge
- 19h 50m
- Merged PRs (30d)
- 6
Description
Preliminary Checks
- This issue is not a question, feature request, RFC, or anything other than a bug report. Please post those things in GitHub Discussions: https://github.com/nebari-dev/nebari/discussions
Summary
We need to document the workflows that run on CI, note that #1819 recently updates the workflows. :)
Steps to Resolve this Issue
- We can create a new page in Community -> Maintainers section for CI docs
- We also need to update https://www.nebari.dev/docs/community/code-contributions, to note that some PRs should not be made from forks to ensure the relevant tests run.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Review the CI workflows, issue #1819, and the existing Community → Code Contributions page first. Document the workflows in a new Community → Maintainers page, and update the contribution guidance about when PRs should not come from forks so the relevant tests run. Done means both documentation locations cover the requested CI behavior.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- github-actions
- Domain
- ci-cd, documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100