Remove "2020 AP Stylebook" link #2691
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
| @@ -5,8 +5,6 @@ description: Best practices for writing style, grammar, and formatting. | |||
| previewImage: assets/illustrations/content/writing-style.jpg | |||
| --- | |||
|
|
|||
| Generally, HashiCorp follows the [2020 AP Stylebook](https://www.apstylebook.com/ap_stylebook) rules and guidelines, unless HashiCorp specific style is indicated. | |||
|
|
|||
There was a problem hiding this comment.
Do we still follow AP Style generally though? I think this is useful information to know if so. I would just remove the link in that case.
There was a problem hiding this comment.
If we want to keep a reference, could change to:
"Generally, HashiCorp follows the 2020 AP Stylebook rules and guidelines, unless HashiCorp specific style is indicated."
or
"Generally, HashiCorp follows the AP Style rules and guidelines, unless HashiCorp specific style is indicated."
If we still want to link to more information, below are other possible links we could consider.
Includes a summary of AP Style:
https://writer.com/blog/a-comprehensive-guide-to-the-ap-style-of-writing/
Wikipedia explanation of what the "AP Stylebook" is: https://en.wikipedia.org/wiki/AP_Stylebook
There was a problem hiding this comment.
The writer.com resource is great! Thanks for sharing @KristinLBradley.
@andgen404 Can you update the text to use Kristin's second example and add the link to the writer.com resource? This feels more helpful for consumers 🙂
Co-authored-by: Heather Larsen <[email protected]>
Co-authored-by: Heather Larsen <[email protected]>
andgen404
dismissed stale reviews from shleewhite and KristinLBradley
via
e0157ac
andgen404
requested review from
KristinLBradley,
shleewhite and
heatherlarsen
| @@ -5,7 +5,7 @@ description: Best practices for writing style, grammar, and formatting. | |||
| previewImage: assets/illustrations/content/writing-style.jpg | |||
| --- | |||
|
|
|||
| Generally, HashiCorp follows the [2020 AP Stylebook](https://www.apstylebook.com/ap_stylebook) rules and guidelines, unless HashiCorp specific style is indicated. | |||
| Generally, HashiCorp follows the [AP Style](https://writer.com/blog/a-comprehensive-guide-to-the-ap-style-of-writing/) rules and guidelines unless a HashiCorp-specific style is indicated. | |||
There was a problem hiding this comment.
| Generally, HashiCorp follows the [AP Style](https://writer.com/blog/a-comprehensive-guide-to-the-ap-style-of-writing/) rules and guidelines unless a HashiCorp-specific style is indicated. | |
| Generally, HashiCorp follows the [AP Style](https://writer.com/blog/a-comprehensive-guide-to-the-ap-style-of-writing/) rules and guidelines, unless a HashiCorp-specific style is indicated. |
[Nit] The comma doesn't need to be removed here.
📌 Summary
This PR will remove the "2020 AP Stylebook" link if merged.
🛠️ Detailed description
The “2020 AP Stylebook” link directs the user to a page that requires a login. Unfortunately, we do not have a company-wide login for this stylebook, so we need to remove the following sentence from the Writing style page:
“Generally, HashiCorp follows the 2020 AP Stylebook rules and guidelines, unless HashiCorp specific style is indicated.”
🔗 External links
Jira ticket: HDS-4294