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.

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

Enhance wording of building-testing page #9509

Merged
merged 2 commits into from Nov 15, 2022
Merged

Enhance wording of building-testing page #9509

merged 2 commits into from Nov 15, 2022

Conversation

svx
Copy link
Contributor

@svx svx commented Nov 15, 2022

What does this PR do?

This PR:

  • Add link descriptions
  • Remove 'weasel' words
  • Add link to website of gocheck
  • Add link to website of Go
  • Add code example

Motivation

Adding link descriptions helps user who use screen reader.
'Weasel' words are not adding value to the content and making sentences longer as they need to be, by removing them, the docs are more 'flowy'.
Adding links helps user which may new to these tools.
Having examples in documentation helps (new) user to understand more effortless and the breaking up the content, which good in terms of document structure and flow.

More

  • Added/updated tests
  • Added/updated documentation

Additional Notes

@rtribotte rtribotte added area/documentation status/2-needs-review bot/light-review decreases the number of required LGTM from 3 to 1. and removed status/0-needs-triage bot/light-review decreases the number of required LGTM from 3 to 1. labels Nov 15, 2022
@rtribotte rtribotte added this to To review in v2 via automation Nov 15, 2022
@rtribotte rtribotte added the kind/enhancement a new or improved feature. label Nov 15, 2022
Copy link
Member

@ldez ldez left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you 👍

Copy link
Member

@rtribotte rtribotte left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks 👍

@rtribotte rtribotte added status/3-needs-merge bot/light-review decreases the number of required LGTM from 3 to 1. and removed status/2-needs-review labels Nov 15, 2022
@kevinpollet kevinpollet changed the title docs(contributing) building-testing -> enhance wording docs(contributing): enhance wording of building-testing page Nov 15, 2022
@traefiker traefiker merged commit 35d8281 into traefik:v2.9 Nov 15, 2022
v2 automation moved this from To review to Done Nov 15, 2022
@traefiker traefiker removed status/3-needs-merge bot/light-review decreases the number of required LGTM from 3 to 1. labels Nov 15, 2022
@rtribotte rtribotte changed the title docs(contributing): enhance wording of building-testing page Enhance wording of building-testing page Nov 17, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
No open projects
v2
Done
Development

Successfully merging this pull request may close these issues.

None yet

5 participants