Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Remove vague link text #2680

Closed
oddlittlebird opened this issue Sep 25, 2020 · 2 comments · Fixed by #2698
Closed

Remove vague link text #2680

oddlittlebird opened this issue Sep 25, 2020 · 2 comments · Fixed by #2698
Labels
good first issue These are great first issues. If you are looking for a place to start, start here! Hacktoberfest

Comments

@oddlittlebird
Copy link
Contributor

oddlittlebird commented Sep 25, 2020 •
edited
Loading

What would you like to be added:

Replace unhelpful link text, such as "here" or "documentation", throughout the Loki technical documentation. "here" is probably the biggest offender.

Link text should be descriptive, preferably the title of the page or section being linked to.

Examples:

  • Incorrect: For more information, go here.
  • Correct: For more information about setting up image rendering, refer to Image rendering.

Why is this needed: To improve the quality of our technical documentation.
@bemasher
Copy link
Contributor

Is there any preference to avoiding bare links?

e.g.
https://helm.sh/docs/using_helm/#installing-helm
vs
Installing Helm

@oddlittlebird
Copy link
Contributor Author

The latter. Link text should be actual words that make sense in the context of the written sentence.

@bemasher bemasher mentioned this issue Sep 30, 2020
Merged
2 tasks
owen-d pushed a commit that referenced this issue Oct 12, 2020
@bemasher @oddlittlebird
Doc: Vague link text. (#2698)
e644095 
* Fixes remove vague link text #2680

* Fix remaining 'docs' links.

* Accept suggestion.

Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com>

* Change HTTP API to Ruler API.

Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com>

* Correct typo.

Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com>

* Capitalize Github.

Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com>

* Capitalize Promtail.

Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com>

* Add copy-edit suggestions from @achatterjee-grafana.

* Incorporate @owen-d's changes.

Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com>
@chaudum chaudum added good first issue These are great first issues. If you are looking for a place to start, start here! and removed beginner-friendly labels Apr 12, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
good first issue These are great first issues. If you are looking for a place to start, start here! Hacktoberfest
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Doc: Vague link text.
3 participants
@bemasher @chaudum @oddlittlebird