(DOCSP-12745) Fixing errors

Author: Anthony Sansone

source/style-guide/includes/terms/l.rst

@@ -132,7 +132,8 @@ L
 
      - Use *login* and *logoff* as nouns or adjectives.
 
-     - Don't use *log into*; use *log in to* instead.
+     - Don't use *log into*; use *log in to*. *Log in* is a single
+       :mw:`phrasal verb`. *To* links that verb to the next word.
 
      .. list-table::
         :widths: 50 50

source/style-guide/style/capitalization.txt

@@ -8,23 +8,8 @@ Capitalization
 
 .. include:: /includes/styles/corrections.rst
 
-Be judicious and consistent in your use of capitalization.
-
-Use capitalization for:
-
-- proper names,
-- proper adjectives, and
-- as style requires.
-
-Don't use capitalization for:
-
-- Common nouns,
-- For emphasis,
-- To attempt to give a word greater status than other words, or
-- At random.
-
-This topic provides general guidelines to help you decide whether a
-term should be capitalized.
+Be judicious and consistent in your use of capitalization. This topic
+provides general guidelines to help you decide to capitalize a term.
 
 .. seealso::
 

source/style-guide/style/product-names-version-numbers.txt

@@ -24,7 +24,7 @@ the following guidelines:
        - MongoDB Atlas
        - MongoDB Compass
 
-   * - On the first mention, use the full MongoDB product name.
+   * - Use the full MongoDB product name on the first mention.
        Subsequent mentions may use the product name without MongoDB.
 
      - .. list-table::
@@ -75,6 +75,17 @@ the following guidelines:
 
      - Never abbreviate S3 Snapshot Store as SSS.
 
+   * - Don't use MongoDB names in the possessive form.
+
+     - Don't write *MongoDB's features*, but
+       *features of MongoDB Community*.
+
+   * - Don't use MongoDB names as part of a contraction.
+
+     - Besides the high chance that such a contraction would use
+       passive voice, this diminishes the trademark and could add
+       ambiguity.
+
    * - Use full, three-digit version numbers when referring to a
        specific release or feature. Use the two-digit release series
        when referring to a common feature.

source/style-guide/terminology/terms-for-global-audience.txt

@@ -40,7 +40,7 @@ speakers to understand.
 
 Avoid idioms and colloquialisms as often as possible.
 
-The following table lists some idioms and colloquialisms, and provides
+The following table lists some idioms and colloquialisms and provides
 alternatives that you can use.
 
 .. list-table::
@@ -156,11 +156,11 @@ users and difficult to translate.
 - Consider explaining any jargon that you use if the audience isn't
   highly technical.
 
-The following table lists some jargon typically used in the high tech
-industry and some possible alternatives.
+The following table lists some jargon typical of the tech industry and
+possible alternatives.
 
 .. list-table::
-   :widths: 20 5 25 50
+   :widths: 20 10 20 50
    :header-rows: 1
 
    * - Jargon
@@ -169,83 +169,83 @@ industry and some possible alternatives.
      - Examples
 
    * - abort
-     - (v)
+     - v
      - stop, end, cancel
      - If an error occurs during data entry, the update process stops.
 
    * - boot, reboot
-     - (v)
+     - v
      - start, restart
      - To apply your changes, restart the server.
 
    * - bounce
-     - (v)
+     - v
      - restart
      - Restart the service.
 
    * - box
-     - (n)
+     - n
      - computer, server
      - The configuration specifies four servers.
 
    * - cache
-     - (v)
+     - v
      - place in cache
      - For quick access, you can place the command in cache.
 
    * - debug
-     - (v)
+     - v
      - resolve
      - After you resolve the problem, restart the server.
 
    * - dropped
-     - (adj)
+     - adj
      - discontinued
      - In this release, support for Windows is discontinued.
 
    * - execute
-     - (v)
+     - v
      - run
      - Run the script.
 
    * - fire, fire up
-     - (v)
+     - v
      - start
      - After repairs are completed, you can start the server.
 
    * - freeze
-     - (v)
+     - v
      - stop responding
      - If the console stops responding, restart the application.
 
    * - grayed, grayed out
-     - (adj)
+     - adj
      - unavailable, dimmed
      - You can't reduce the size of a Windows server, so options for
        smaller size servers are unavailable.
 
    * - hang
-     - (v)
+     - v
      - stop responding
      - A severe error might cause the server to stop responding.
 
    * - interface
-     - (v)
+     - v
      - connect, communicate, interact
      - Host 1 interacts with Host 2.
 
    * - kill
-     - (v)
+     - v
      - stop, end, terminate
      - You can terminate the process by pressing Ctrl+C.
 
    * - launch
-     - (v)
+     - v
      - start
      - Start the application monitor in debug mode.
 
    * - machine
-     - (n)
+     - n
      - computer, server, host
      - If a UFO lands in the data center, the servers stop working.
 
@@ -254,33 +254,29 @@ industry and some possible alternatives.
           correct.
 
    * - ping
-     - (v)
+     - v
      - contact, alert
      - To verify the connection, use the ping command to contact the
        other server.
 
    * - sanity check
-     - (v)
+     - v
      - test, evaluate
      - You can use a pre-existing function to evaluate the data that
        users enter.
 
-   * - slave
-     - (n, adj)
-     - subordinate, secondary
-     - Database replication that uses a master database server and a
-       secondary (or slave) database server provides key advantages.
-
    * - spin up
-     - (v)
+     - v
      - create
      - If you need more capacity, create a new server.
 
    * - throw
-     - (v)
+     - v
      - generate
      - If the program fails, an error is generated.
 
+.. _culture-neutral:
+
 Use Culture-Neutral Language and Examples
 -----------------------------------------
 
@@ -305,6 +301,86 @@ If you create "named" users for extended examples or scenarios, use
 names that represent a variety of ethnic backgrounds, genders, and
 locations.
 
+.. _oppressive-language:
+
+Use Non-Oppressive Language
+---------------------------
+
+The words you choose can have meanings separate from their dictionary
+definitions. To ignore that ignores the power of speech and writing.
+MongoDB wants to empower everyone to use our technology. Keeping with
+that goal, we must consider our use of terms identified as racist,
+sexist, or otherwise oppressive. Some terms lack any ambiguity.
+
+The following table lists terms to avoid and some acceptable
+alternatives.
+
+.. list-table::
+   :widths: 20 10 20 50
+   :header-rows: 1
+
+   * - Term
+     - Part
+     - Alternatives
+     - Examples
+
+   * - black hat
+     - adj
+     - unethical
+     - MongoDB discourages unethical hacking of its databases.
+
+   * - blacklist
+     - v
+     - remove (from an access list), deny (access to),
+       block (access to)
+     - MongoDB Atlas denies that IP address access to the database.
+
+   * - blacklist
+     - n
+     - access list, blocklist, exclude list
+     - That IP address has been removed from the access list for the
+       **shipwreck** database.
+
+   * - master
+     - n, adj
+     - primary, active, coordinator
+     - Replica sets have one primary and two or more secondary members.
+
+   * - slave
+     - n, adj
+     - secondary, standby, subordinate, replica, worker
+     - Replica sets have one primary and two or more secondary members.
+
+   * - slave
+     - v
+     - subordinate
+     - This slower hard drive has been subordinated to this faster hard
+       drive for backup purposes.
+
+       .. note::
+
+          Docs discourages using either term as a verb. This is
+          included to account for possible usage.
+
+   * - white hat
+     - adj
+     - ethical
+     - MongoDB understands that you may need to conduct ethical hacking
+       to test the security of your databases.
+
+   * - whitelist
+     - v
+     - add (to an access list), allow (access to), permit (access to)
+     - MongoDB Atlas allows that IP address to access to the database.
+
+   * - whitelist
+     - n
+     - access list, allow list, allowed list
+     - That IP address has been added from the access list for the
+       **shipwreck** database.
+
+.. _neutral-graphics:
+
 Use Culture-Neutral Graphics
 ----------------------------
 

source/style-guide/writing/use-that-which-correctly.txt

@@ -47,17 +47,18 @@ Make sure to clarify restrictive clauses, as follows:
    successive nouns.
 -  Don't substitute *which* for *that*.
 -  For the use of *such as*, use a comma before a nonrestrictive clause
-   and don't use a comma for a restrictive clause. You can tell if the
-   clause is nonrestrictive by taking the phrase starting with *such
-   as* out of the sentence and see whether the sentence is still true.
-   For example:
+   and don't use a comma for a restrictive clause. To tell if the
+   clause is nonrestrictive, remove the phrase starting with *such
+   as* out of the sentence. See whether the sentence remains true.
 
-   - In this forest, you can see many types of coniferous trees, such
-     as pine and spruce.
+   .. example::
 
-   - In this forest, you can see many types of coniferous trees.
+      - In this forest, you can see many types of coniferous trees,
+        such as pine and spruce.
 
-   See *such as* in the :ref:`alphabetical-list-of-terms` for more examples.
+      - In this forest, you can see many types of coniferous trees.
+
+   .. seealso:: :term:`such as`.
 
 .. list-table::
    :widths: 50 50

source/style-guide/writing/write-clear-concise-sentences-paragraphs.txt

@@ -136,9 +136,9 @@ An expletive sentence begins with *It* or *There* and followed by a form of *be*
    * - We need to solve this problem.
      - It is necessary for us to find a solution to this problem.
 
-   * - There are three benefits to the cloud backup compared to the
+   * - Cloud backup has three benefits over legacy backup.
+     - There are three benefits to the cloud backup compared to the
        legacy backup.
-     - Cloud backup has three benefits over legacy backup.
 
 .. _sg-avoid-nominalizations: