oppia / oppia/oppia-web-developer-docs
Add examples for writing job run instructions
Open
Nobody has claimed this yet.
bug
Impact: Medium
Work: Medium
- Dominant language
- Python
- Stars
- 18
- Forks
- 134
- PR merge metrics
- No merged PRs in 30d
Description
In the wiki page related to beam job runs, it would be nice to have some sample "job run instruction" docs so that developers can follow those as examples. This will give the reader an idea about the level of clarity required in the doc.
Contributor guide
No contributing guide indexed for this repository
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 by locating the wiki page related to Beam job runs and review any existing job run instruction documentation. Add sample instruction documents that demonstrate the expected level of clarity, then verify the examples are understandable to developers using the page.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100