Based off conversation at the PTG, we agreed it would be beneficial to ensure the contrib-guide is clearly marked as the doc contrib guide outside of the title. This change includes a redirect. Change-Id: I5abf915f0b94a482afa961e6b86364c26aae5d79
5.2 KiB
5.2 KiB
Word choice
This section offers conventions around general English usage and the
terms that are not covered in the glossary. Additionally, use the IBM
Terminology as a reference.
The following table lists the preferred word or phrase choice.
Preferred word choice
| Word | Do not use |
|---|---|
| and so on | etc. |
| back end (noun) | backend, back-end In general, avoid. Use a more specific term, such as server, operating system, or network. |
| back-end (adj) | backend, back end |
| cancel | abort |
| complete | done, finish |
| command line (noun) | command-line |
| command-line (adj) | command line |
| compute node | Compute node |
| data store | datastore |
| delete | destroy |
| to do something | in order to do something |
| Ethernet | ethernet |
| example | i.e, e.g. |
| host name | hostname, Hostname |
| lifecycle | life cycle |
| login (noun) | logon, log-in |
| log in (verb) | login |
| OpenStack | openstack, Openstack |
| plug-in | plugin |
| run, issue, start, enter | Avoid using "execute" unless it is the most appropriate term in the context. |
| select | check |
| setup (noun) | set up, set-up |
| set up (verb) | setup |
| an SQL | a SQL |
| such as | like |
| verify | be sure |
| X-as-a-Service | X as a Service |