opendevstack / opendevstack/ods-core
Point from README to antora documentation
Nobody has claimed this yet.
- Dominant language
- Shell
- Stars
- 53
- Forks
- 34
- Avg merge
- 3h 26m
- Merged PRs (30d)
- 1
Description
We have a lot of READMEs alongside the base images.
These READMEs should simply point to the corresponding antora documentation, to avoid documentation duplication.
(The antora documentation has the advantage, that it is versioned. So we will have always the correct version displayed on the website that matches a release version.)
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 README files alongside the base images and identify the corresponding Antora documentation pages. Replace duplicated README content with links to the versioned Antora documentation, then verify that each base image README points to the correct page for its release version.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100