[DOCS] Inconsistent links to Tutorials/Salt User Guide
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 15.7k
- Forks
- 5.6k
- Avg merge
- 2d 44m
- Merged PRs (30d)
- 80
Description
Description
When you go to the Downloads section of the website, the bar on top links to Tutorials from 2016 instead of the newer Salt User Guide. Every other tab on the website links to the Salt User Guide instead.
Suggested Fix
Make all navbar tabs consistently link to documentation instead of changing when you go to different pages.
Type of documentation
Salt documentation and Getting Started guide.
Location or format of documentation
https://repo.saltproject.io/
Additional context
I'm new to SaltStack and I find it rather confusing that different parts of the website link me to different documentation. Where am I actually supposed to start, documentation-wise? Some parts of the website say I should start with the Salt User Guide, while others say I should start with the Tutorials section.
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 at the Downloads page on repo.saltproject.io and compare its top navigation with the other website tabs and the linked Salt User Guide. Locate the source for that navbar, update the inconsistent Tutorials destination, and verify that the affected tabs consistently open the intended documentation.
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