[DOCS] Change point to internal links
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 15.7k
- Forks
- 5.6k
- Avg merge
- 2d 44m
- Merged PRs (30d)
- 80
Description
Description
I noticed that the salt documentation quite often refers to other parts of it self. However instead of linking inside the documentation itself links to externally hosted documentation are used.
Suggested Fix
Point the reference inside the documentation itself which then will point
to the local file or the same host the currently opened file originates from.
Type of documentation
The main salt documentation
Location or format of documentation
doc/topics/tutorialsquickstart.rst#L23
Additional context
If possible footnotes should be entirely avoided and replaced with links be it internal or external.
Contributor guide
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 doc/topics/tutorialsquickstart.rst at line 23 and inspect the surrounding references to externally hosted Salt documentation. Identify references that have corresponding locations in the main documentation and point them to local or same-host links; avoid footnotes where direct links are appropriate. Done means the affected references use internal documentation links without breaking the rendered documentation.
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
- 42/100