-
Notifications
You must be signed in to change notification settings - Fork 45
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
Remove "2020 AP Stylebook" link #2691
base: main
Are you sure you want to change the base?
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Added a comment with a question. I don't think we should necessarily delete the whole reference. (Personally, I find it useful to know that we base our guidelines partly off of AP Style.)
📌 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