Skip to content

Commit 62b07b1

Browse files
author
Chris Cho
committed
grammar fixes
1 parent b9a6726 commit 62b07b1

File tree

1 file changed

+23
-23
lines changed

1 file changed

+23
-23
lines changed

source/style-guide/markup/directives/sharedinclude.txt

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Shared Include
77
The ``sharedinclude`` directive lets you source content from a file located in
88
the MongoDB internal `docs-shared <https://github.com/10gen/docs-shared>`__
99
repository. Use this directive when you need to keep the same content in sync
10-
for multiple sets of documentation or multiple branches of a documentation set.
10+
for multiple sets of documentation or branches of a documentation set.
1111

1212
This page uses the following terms:
1313

@@ -20,17 +20,17 @@ Sourcing file
2020
directive to pull content from an external file.
2121

2222
Placeholder
23-
A variable that indicates text that the sourcing file must provide a
24-
replacement for. These variables are represented by the placeholder name
25-
surrounded by the ``|`` (pipe) character. The variables are used in
26-
external files.
23+
A variable that identifies where replacement content should be inserted.
24+
These variables are represented as a name surrounded by the ``|`` (pipe)
25+
character. Add them in the external file and define the replacement content
26+
in the sourcing file.
2727

2828
.. tip::
2929

30-
The ``sharedinclude`` directive is an extension of the ``include`` directive.
30+
The ``sharedinclude`` directive extends the ``include`` directive.
3131
While the ``include`` directive allows you to source content from the
3232
branch of the repository in which it is used, the ``sharedinclude``
33-
directive is hardcoded to reference external files from the
33+
directive is hard-coded to reference external files from the
3434
`10gen/docs-shared <https://github.com/10gen/docs-shared/>`__
3535
private GitHub repository.
3636

@@ -41,7 +41,7 @@ Setup
4141
You must ensure the ``sharedinclude_root`` setting in the documentation
4242
repository's ``snooty.toml`` configuration file is set to the shared
4343
content repository URL. This URL must point to the unprocessed version of the
44-
files, currently served from the ``raw.githubusercontent.com`` domain.
44+
files currently served from the ``raw.githubusercontent.com`` domain.
4545

4646
For example, if the external files that your docs repository file references
4747
is on the ``main`` branch of ``docs-shared``, your docs repository
@@ -58,23 +58,23 @@ configuring this setting.
5858
Syntax
5959
------
6060

61-
To include content from an external file, add the ``sharedinclude`` directive
62-
to the sourcing file. Specify the path of the external file relative to the
61+
Add the ``sharedinclude`` directive to the sourcing file to include content
62+
from the external file. Specify the path of the external file relative to the
6363
``docs-shared`` base directory, omitting the leading slash.
6464

6565
For example, if the file path from the root of the ``docs-shared`` repository
66-
is ``drivers/compatibility-tables/c.rst``, the {+rst-abbrev+} in the sourcing file
67-
should include the following code:
66+
is ``drivers/compatibility-tables/c.rst``, the {+rst-abbrev+} in the sourcing
67+
file should include the following code:
6868

6969
.. code-block:: rst
7070
:caption: sourcing_file.txt in a documentation repository
7171
:copyable: false
7272

7373
.. _sharedinclude:: drivers/compatibility-tables/c.rst
7474

75-
The external file can include replacement variables in the form of
76-
``|variable-name|``. This enables the sourcing file to customize segments
77-
of the page.
75+
The external file includes replacement variables in the form of
76+
``|variable-name|``. You can define the replacement values in sourcing files
77+
to customize segments of the page.
7878

7979
For example, suppose the ``docs-shared`` file ``language.rst`` contained the
8080
following content with a replacement variable called ``|driver-name|``:
@@ -118,15 +118,15 @@ Placeholders in Inline Context
118118

119119
An **inline context** describes the positioning of placeholders as adjacent to
120120
other paragraph text. If the placeholder is in an inline context, you can
121-
replace it with markup elements including the following types:
121+
replace it with markup elements, including the following types:
122122

123123
- Unformatted text
124124
- Formatted text such as ``monospace``, **emphasis**, or *italic*
125125
- Links
126126

127127
You cannot replace variable placeholders in inline contexts with elements
128128
such as lists, code blocks, includes, and headers. If you need to
129-
source these elements from a ``sharedinclude``, make sure the placeholders
129+
source these elements from a ``sharedinclude``, ensure the placeholders
130130
are in a block context as described in the next section.
131131

132132
For example, suppose you want to source content from an external file, located
@@ -167,24 +167,24 @@ Placeholders in Block Context
167167
`````````````````````````````
168168

169169
A **block context** describes the positioning of placeholders as
170-
separated from paragraph text by line breaks. You can replace variable
171-
placeholders in a block context with most inline or block {+rst-abbrev+}
172-
elements, including the following types:
170+
separated from paragraph text by line breaks. You can replace placeholders in
171+
a block context with most inline or block {+rst-abbrev+} elements, including
172+
the following types:
173173

174174
- Titles
175175
- Code blocks
176176
- Anchors
177177
- Admonitions
178178

179-
For example, suppose you want to source content from an external file, located
179+
For example, suppose you want to source content from an external file located
180180
at ``dbx/fundamentals/agg-operators.rst`` in the ``docs-shared`` repository,
181181
which contains the following content:
182182

183183
.. code-block:: rst
184184
:caption: dbx/fundamentals/agg-operators.rst external file in docs_shared
185185
:copyable: false
186186

187-
The next section demonstrates how to use aggregation operators to build
187+
The following section demonstrates how to use aggregation operators to build
188188
an aggregation pipeline.
189189

190190
|aggregation-operators-example|
@@ -219,7 +219,7 @@ The published page renders as if the sourcing file contained the following {+rst
219219
.. code-block:: rst
220220
:copyable: false
221221

222-
The next section demonstrates how to use aggregation operators to build
222+
The following section demonstrates how to use aggregation operators to build
223223
an aggregation pipeline.
224224

225225
.. _expression-operators-example:

0 commit comments

Comments
 (0)