address feedback on style guide (#2675)

This commit is contained in:
susan evans
2023-04-10 17:41:57 -07:00
committed by GitHub
parent b10a614470
commit b6d6f850ba
+1 -1
View File
@@ -26,7 +26,7 @@ Words are important. Pulumi strives to use language that is clear, harmonious, a
## Links
* Link text should be descriptive and have meaning outside of the surrounding context: Avoid link text like _here_, _click here_, _see here_ and instead link to the title of the linked page, e.g. "see [Pulumi Pricing](https://www.pulumi.com/pricing/)". (While this practice benefits all readers, it is of particular important for visually impared users who use screen readers and often jump through the links of a document.)
* Link text should be descriptive and have meaning outside of the surrounding context: Avoid link text like _here_, _click here_, _see here_ and instead link to the title of the linked page, e.g. "see [Pulumi Pricing](https://www.pulumi.com/pricing/)". (While this practice benefits all readers, it is of particular importance for visually impaired users who use screen readers and often jump through the links of a document.)
* When changing the URL for an already existing page, add a redirect by using a [Hugo alias](https://gohugo.io/content-management/urls/#yaml-front-matter).
## Notes and Warnings