-
Notifications
You must be signed in to change notification settings - Fork 144
Writing Tips and Tricks
This is a section to handle some writing advice that is too detailed to put in our Style Guide but might be of interest to docs contributors.
How would you position the word "only" to make it more translation-friendly? (Hint: which option is easier for you to understand?)
Option 1: You can only live migrate instances when the parameter is set to "true". This parameter is only enabled by default when the host is configured for a particular deployment.
Option 2: You can live migrate instances only when the parameter is set to "true". This parameter is enabled by default only when the host is configured for a particular deployment.
Answer: Option 2 is more localization friendly. "only" should be placed just before the words or phases that it emphasizes. It can cause ambiguity when it appears too early in the sentence, as in Option 1.
This Wiki is used for quick notes, not for support or documentation.
Working groups are now in the Ansible forum
Ansible project:
Community,
Contributor Experience,
Docs,
News,
Outreach,
RelEng,
Testing
Cloud:
AWS,
Azure,
CloudStack,
Container,
DigitalOcean,
Docker,
hcloud,
Kubernetes,
Linode,
OpenStack,
oVirt,
Virt,
VMware
Networking:
ACI,
AVI,
F5,
Meraki,
Network,
NXOS
Ansible Developer Tools:
Ansible-developer-tools
Software:
Crypto,
Foreman,
GDrive,
GitLab,
Grafana,
IPA,
JBoss,
MongoDB,
MySQL,
PostgreSQL,
RabbitMQ,
Zabbix
System:
AIX,
BSD,
HP-UX,
macOS,
Remote Management,
Solaris,
Windows
Security:
Security-Automation,
Lockdown
Tooling:
AWX,
Galaxy,
Molecule
Plugins:
httpapi