Skip to content

Commit 0c7da0d

Browse files
Anthony Sansoneatsansone
authored andcommitted
(DOCSP-11541) Remove pending approval banner
1 parent 9c389f9 commit 0c7da0d

File tree

14 files changed

+63
-33
lines changed

14 files changed

+63
-33
lines changed

source/style-guide/error-message-guidelines.txt

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,9 @@
44
Error Message Guidelines
55
========================
66

7-
.. include:: /style-guide/includes/page-needs-update.rst
7+
.. default-domain:: mongodb
8+
9+
.. include:: /includes/styles/corrections.rst
810

911
<<<<<<< HEAD
1012
Developers often ask an Information Developer to edit error messages

source/style-guide/style/contractions.txt

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,9 @@
44
Contractions
55
============
66

7-
.. include:: /style-guide/includes/page-needs-update.rst
7+
.. default-domain:: mongodb
8+
9+
.. include:: /includes/styles/corrections.rst
810

911
Contractions help to create a less formal tone in documentation. Common
1012
contractions, such as *can’t* and *don’t*, are usually recognizable by

source/style-guide/style/dates.txt

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,9 @@
44
Dates
55
=====
66

7-
.. include:: /style-guide/includes/page-needs-update.rst
7+
.. default-domain:: mongodb
8+
9+
.. include:: /includes/styles/corrections.rst
810

911
Dates are displayed differently in different countries, so you must use
1012
a date format that's explicit and consistent and that global users

source/style-guide/style/file-types.txt

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,9 @@
44
File Types
55
==========
66

7-
.. include:: /style-guide/includes/page-needs-update.rst
7+
.. default-domain:: mongodb
8+
9+
.. include:: /includes/styles/corrections.rst
810

911
For references to a file type in text (not code), use one of the
1012
following naming conventions, depending on the type of file and the

source/style-guide/style/glossaries.txt

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,9 @@
44
Glossaries
55
==========
66

7-
.. include:: /style-guide/includes/page-needs-update.rst
7+
.. default-domain:: mongodb
8+
9+
.. include:: /includes/styles/corrections.rst
810

911
Create a glossary to document the following items:
1012

source/style-guide/style/index.txt

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,10 @@
44
Style Guidelines
55
================
66

7+
.. default-domain:: mongodb
8+
9+
.. include:: /includes/styles/corrections.rst
10+
711
This section of the style guide provides detailed guidelines about and
812
instructions for applying style conventions.
913

source/style-guide/style/keyboard-keys.txt

Lines changed: 23 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,9 @@
44
Keyboard Keys
55
=============
66

7-
.. include:: /style-guide/includes/page-needs-update.rst
7+
.. default-domain:: mongodb
8+
9+
.. include:: /includes/styles/corrections.rst
810

911
Different keyboards use different names for common keys. For
1012
consistency, use the following key names unless the technology that you
@@ -33,8 +35,8 @@ are documenting requires other forms:
3335
- Up Arrow
3436

3537
When showing specific key names and key combinations, use the following
36-
guidelines. For more information about formatting keyboard key combinations,
37-
names, and shortcuts, see :ref:`text-formatting`.
38+
guidelines. For more information about formatting keyboard key
39+
combinations, names, and shortcuts, see :ref:`text-formatting`.
3840

3941
.. list-table::
4042
:widths: 50 50
@@ -49,7 +51,7 @@ names, and shortcuts, see :ref:`text-formatting`.
4951
*type* or *enter* when the action results in output on the
5052
interface.
5153

52-
- When prompted, type ``y`` and then press **Enter**.
54+
- When prompted, type ``y`` and then press :kbd:`Enter`.
5355

5456
To change from command mode to insert mode, type ``i``.
5557

@@ -60,40 +62,40 @@ names, and shortcuts, see :ref:`text-formatting`.
6062
.. note::
6163
Don't use the verbs *hit*, *strike*, or *punch*.
6264

63-
Separate the key names by **-** or **+**, depending on whether
65+
Separate the key names by :kbd:`-` or :kbd:`+`, depending on whether
6466
you're documenting Linux or Windows. If you're documenting for
6567
both, pick one symbol and use it consistently.
6668

67-
- When you're finished, press **Ctrl+X** to exit, type ``y`` to
68-
confirm your changes, and then press **Enter** to save as the
69+
- When you're finished, press :kbd:`Ctrl+X` to exit, type ``y`` to
70+
confirm your changes, and then press :kbd:`Enter` to save as the
6971
indicated file.
7072

71-
Press **F3** to find the next matching process, or press **Esc**
72-
to quit the search.
73+
Press :kbd:`F3` to find the next matching process, or press
74+
:kbd:`Esc` to quit the search.
7375

74-
To move forward word by word, press **W**. To move back word by
75-
word, press **B**.
76+
To move forward word by word, press :kbd:`W`. To move back word
77+
by word, press :kbd:`B`.
7678

7779
To toggle between the progress bar screen and a Linux TTY
78-
screen, press **Ctrl-Alt-F2**.
80+
screen, press :kbd:`Ctrl-Alt-F2`.
7981

80-
* - If part of a key combination requires the use of the **Shift**
82+
* - If part of a key combination requires the use of the :kbd:`Shift`
8183
key (such as typing an asterisk or an uppercase letter), add
82-
**Shift** to the combination and then provide the name or symbol
83-
that results from pressing **Shift** (such as \*\*\*\*\* or
84-
**P**).
84+
:kbd:`Shift` to the combination and then provide the name or
85+
symbol that results from pressing :kbd:`Shift` (such as
86+
\*\*\*\*\* or :kbd:`P`).
8587

86-
- To jump to the end of the file, press **Shift+G**.
88+
- To jump to the end of the file, press :kbd:`Shift+G`.
8789

88-
To apply the general number format, press **Ctrl+Shift+~**.
90+
To apply the general number format, press :kbd:`Ctrl+Shift+~`.
8991

9092
* - Avoid using *key* with specific key names.
9193

9294
If needed for clarity, on the first use of a key name, you can
9395
use the definite article *the* and *key* with the name. On
9496
subsequent uses, refer to the key only by its name.
9597

96-
- Press **F3** to find the next matching process, or press **Esc**
97-
to quit the search.
98+
- Press :kbd:`F3` to find the next matching process, or press
99+
:kbd:`Esc` to quit the search.
98100

99-
Press the Help key (**F1**).
101+
Press the Help key (`F1`).

source/style-guide/style/messages.txt

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,9 @@
44
Messages
55
========
66

7-
.. include:: /style-guide/includes/page-needs-update.rst
7+
.. default-domain:: mongodb
8+
9+
.. include:: /includes/styles/corrections.rst
810

911
If you help write the message text for a product or you suggest edits
1012
to message text, use the guidelines in this topic.

source/style-guide/style/numbers.txt

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,9 @@
44
Numbers
55
=======
66

7-
.. include:: /style-guide/includes/page-needs-update.rst
7+
.. default-domain:: mongodb
8+
9+
.. include:: /includes/styles/corrections.rst
810

911
Use the following guidelines for showing numbers in documentation.
1012

source/style-guide/style/plurals.txt

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,9 @@
44
Plurals
55
=======
66

7-
.. include:: /style-guide/includes/page-needs-update.rst
7+
.. default-domain:: mongodb
8+
9+
.. include:: /includes/styles/corrections.rst
810

911
Use the following general guidelines for forming and using plurals. To
1012
find out how to form the plural of a particular word, or for

0 commit comments

Comments
 (0)