opendevstack / opendevstack/ods-documentation
System Requirements are not documented properly
Nobody has claimed this yet.
- Dominant language
- CSS
- Stars
- 0
- Forks
- 6
- PR merge metrics
- No merged PRs in 30d
Description
We need to have a section about system requirements, evolving with each version.
E.g. ODS 2.0 introduces the need to configure max_map_count because SonarQube 7.9 has different requirements than 7.3, see https://docs.sonarqube.org/7.9/requirements/requirements/.
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
Review the versioned Antora documentation and the linked SonarQube 7.9 requirements page first. Add a system-requirements section that can be updated for each version, including the max_map_count requirement, and verify that the documentation explains the differing requirements across versions.
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