openedx / openedx/docs.openedx.org
Write Dev Guide 5.1 GitHub Actions
Open
Nobody has claimed this yet.
developers
- Dominant language
- JavaScript
- Stars
- 35
- Forks
- 95
- Avg merge
- 5d 15h
- Merged PRs (30d)
- 3
Description
- Write a guide to GitHub Actions as used in the openedx project https://github.com/openedx/docs.openedx.org/pull/432
- Rename the file from
jenkinstoghahttps://github.com/openedx/docs.openedx.org/pull/432 - Move to section "Writing Good Code" (currently section 7)
https://docs.openedx.org/en/latest/developers/references/legacy_guide/testing/jenkins.html
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
Start with the existing guide at developers/references/legacy_guide/testing/jenkins.html and review the completed GitHub Actions guide work in docs.openedx.org pull request 432. Move the guide to the "Writing Good Code" section, currently section 7, and verify that the documentation navigation and link still work.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- github-actions
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 45/100