openstack/openstack-manuals
Code Issues Proposed changes

[contributor] adjust table format to edit easily

Browse Source 
Change-Id: Iad25b1204343fb3b49df44e0851cabade6dc3208
This commit is contained in:
KATO Tomoyuki 2017-01-10 12:03:23 +09:00
parent a10e9ab10e
commit 1678b30a67
1 changed files with 63 additions and 70 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

133
doc/contributor-guide/source/writing-style/word-choice.rst
View File

@ -15,73 +15,66 @@ 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 | command-line |
| (noun)** | |
+---------------------+----------------------+
| **command-line | command line |
| (adj)** | |
+---------------------+----------------------+
| **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, | Avoid using "execute"|
| start, enter** | 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 |
+---------------------+----------------------+
+-------------------------------------+-------------------------------------+
| **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 |
+-------------------------------------+-------------------------------------+