Skip to content

Commit 6ce47ae

Browse files
author
Chris Cho
authored
Merge pull request #132 from ccho-mongodb/113022-fix-broken-links
Fix broken links in the style guide
2 parents b77240a + 8ac8638 commit 6ce47ae

File tree

6 files changed

+7
-10
lines changed

6 files changed

+7
-10
lines changed

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

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,3 @@ In Snooty, you can use only the ``list-table`` directive to build tables.
88
The ``list-table`` directive generates a formatted table from a two-level
99
bulleted list.
1010

11-
To learn more about the ``list-table`` directive from the
12-
`{+docutils+} documentation </directives#list-table>`__.
13-

source/style-guide/release-notes-guidelines.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,8 @@ Release Notes Guidelines
99
This topic provides guidelines for writing release notes (RN) for
1010
MongoDB Cloud services APIs.
1111

12-
A template for API RN is available in `on
13-
GitHub <https://github.com/rackerlabs/docs-repo-template/blob/master/api-guide-template/release-notes/releases/release-notes-template.rst>`__.
12+
Follow the Rackspace `Release Guidelines <https://docs.rackspace.com/docs/style-guide/release-notes-guidelines/>`__
13+
from the Rackspace Style Guide.
1414

1515
For an example that illustrates most of these guidelines, see the
1616
:opsmgr:`Ops Manager Server Release Notes </release-notes/application/>`.

source/style-guide/style/links-and-cross-references.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -192,9 +192,9 @@ Link and Cross-Reference Examples
192192
storage engines.
193193

194194
* - The snapshot retention policy is described in
195-
:atlas:`cloud-provider-retention-policy`.
195+
:atlas:`Backup Scheduling, Retention, and On-Demand Snapshots </backup/cloud-backup/scheduling>`.
196196
- The snapshot retention policy is described
197-
:atlas:`later in the Atlas documentation <cloud-provider-retention-policy>`.
197+
:atlas:`later in the Atlas documentation </backup/cloud-backup/scheduling>`.
198198

199199
* - The following table lists which MongoDB versions and components
200200
the current releases of MongoDB Ops Manager support.

source/style-guide/style/placeholder-variable-text.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ When creating placeholder text, use the following guidelines.
7878

7979
- Don't separate the words with spaces or symbols
8080
- Capitalize the first letter of each word after the first word
81-
(called :wikipedia:`camelCase </Camel_case>`)
81+
(called :wikipedia:`camelCase <Camel_case>`)
8282
- Never capitalize the first word
8383

8484
.. note::

source/style-guide/terminology/general-term-guidelines/use-consistent-terms.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ consistently throughout the documentation.
4545
same document can be confusing to users and translators, so avoid
4646
it when possible.
4747

48-
- Avoid `neologisms <https://www.merriam-webster.com/dictionary/phrasal-verb/neologism>`__. Examples of neologisms -- or
48+
- Avoid neologisms. Examples of neologisms -- or
4949
newly invented words -- are *marketecture* or *edutainment*. Most
5050
such words are specific to a single business culture and aren't
5151
understood in other cultures.

source/style-guide/writing/clarify-modifiers.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@ Dangling Modifiers
9191
Modifier clauses at the beginning or end of a sentence should modify
9292
the subject of the main clause. When the subject is missing or the
9393
clause modifies another object in the sentence, the clause is called a
94-
:wikipedia:`dangling modifier </Dangling_modifier?oldid=877876557>`.
94+
:wikipedia:`dangling modifier <Dangling_modifier?oldid=877876557>`.
9595

9696
.. list-table::
9797
:widths: 33 33 33

0 commit comments

Comments
 (0)