UCL-ARC / UCL-ARC/mkdocs-rc-docs
Revise the software guide to call out software that requires license groups
Open
Nobody has claimed this yet.
- Dominant language
- Rich Text Format
- Stars
- 41
- Forks
- 22
- Avg merge
- 1m
- Merged PRs (30d)
- 14
Description
E.g. users must be in a special group to use ORCA, but this is not indicated in the documentation.
However this can wait while we finish revising the groups themselves.
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 with the Software Guides > Other Software documentation linked in the issue, using the ORCA entry as the example. Review how software requiring license groups is currently described, then update the relevant entries once the group definitions are finished. Done means affected software clearly indicates that users need membership in a special group.
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