eclipse-iceoryx / eclipse-iceoryx/iceoryx
Create script to adjust documentation links from `master` to `v2.0.0`
- Dominant language
- C++
- Stars
- 2.2k
- Forks
- 492
- Avg merge
- 18h 57m
- Merged PRs (30d)
- 1
Description
## Brief feature description
Most of the markdown documentation has absolute links to the master branch. When we release iceoryx we have to ensure that those links are pointing to the release branch/tag and not master.
But in the master branch those document links should still be pointing to master.
Doing this by hand can be very error prone, a typo or an oversight can destroy a link - so lets write a script which does it for us.
It would be nice that the script also performs some kind of validation and corrects links which are pointing to the wrong tag/branch.
Contributor guide
Research direction
The issue names no existing files, tests, or script entry point. Start by locating the Markdown documentation containing absolute master-branch links and inspect how release tags or branches are represented. Done means the script validates and adjusts links for a release such as v2.0.0 while leaving master-branch documentation links unchanged.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- markdown
- Domain
- documentation, tooling
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100