-
Notifications
You must be signed in to change notification settings - Fork 21
Fixes for 7.2 #667
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
base: dev
Are you sure you want to change the base?
Fixes for 7.2 #667
Conversation
daobrien
left a comment
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.
Mostly ok but a few things need updating.
| <listitem> | ||
| <para> | ||
| DRaaS (Disaster Recovery-as-a-Service) | ||
| AIaaS (Artificial Intelligence-as-a-Service) |
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.
This actually contradicts the previous para: "When spelling it out, do not capitalize the term". You might like to update that para to include "unless part of a proper noun" or similar.
We also do not need all these examples of aaS terms. We need basic guidance and a list of any exceptions, and that's all. Otherwise this list is going to get very long over time.
en-US/A.xml
Outdated
| <listitem> | ||
| <para> | ||
| Avoid use of an acronym if it could stand for more than one term in a single asset. for example, if you are writing content that discusses both Cloud-as-a-Service and Containers-as-a-Service. | ||
| Avoid using an acronym if it could stand for more than one term in a single asset, for example, if you are writing content that discusses both Cloud-as-a-Service and Containers-as-a-Service. |
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.
| Avoid using an acronym if it could stand for more than one term in a single asset, for example, if you are writing content that discusses both Cloud-as-a-Service and Containers-as-a-Service. | |
| Avoid using an acronym if it could stand for more than one term in a single asset. For example, if you are writing content that discusses both Cloud-as-a-Service and Containers-as-a-Service. |
The original version was more correct IMO.
en-US/Design.xml
Outdated
| <title>Writing Effective Titles</title> | ||
| <para> | ||
| Use a title that represents the content. | ||
| Use a title that represents the content. |
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.
Personally I prefer "Use titles that represent..." but that's just me.
en-US/Design.xml
Outdated
| </para> | ||
| <para> | ||
| Avoid a title that consists of only one word. | ||
| Avoid a title that consists of only one word. |
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.
As above.
en-US/Design.xml
Outdated
| <para> | ||
| Do not use manual line indentation for the second and subsequent lines of commands. | ||
| For some output formats, no control is possible over where lines would break, and any indentation might appear as extra spaces in inelegant places. | ||
| For some output formats, no control is possible over where lines would break, and any indentation might appear as extra spaces in inelegant places. |
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.
s/inelegant/awkward/
en-US/Design.xml
Outdated
| <title>Omitting Part of Output</title> | ||
| <para> | ||
| For the sake of brevity, do not show all output to the user in all cases, but only those parts of any output that are relevant to the context that is described. | ||
| For the sake of brevity, do not show all output to the user in all cases, but only those parts of any output that are relevant to the context that is described. |
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.
| For the sake of brevity, do not show all output to the user in all cases, but only those parts of any output that are relevant to the context that is described. | |
| For the sake of brevity, do not show all output to the user in all cases. | |
| Instead, show only those parts of any output that are relevant to the context that is described. |
en-US/Language.xml
Outdated
| <row> | ||
| <entry> The system menu allows you to switch network and VPN connections on or off. </entry> | ||
| <entry> From the system menu, you can switch network and VPN connections on or off. </entry> | ||
| <entry> The <guibutton>system</guibutton> menu allows you to switch network and VPN connections on or off. </entry> |
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.
Shouldn't you be using <guimenu>?
en-US/Language.xml
Outdated
| <entry> The system menu allows you to switch network and VPN connections on or off. </entry> | ||
| <entry> From the system menu, you can switch network and VPN connections on or off. </entry> | ||
| <entry> The <guibutton>system</guibutton> menu allows you to switch network and VPN connections on or off. </entry> | ||
| <entry> From the <guibutton>system</guibutton> menu, you can switch network and VPN connections on or off. </entry> |
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.
As above.
No description provided.