Skip to content

Commit 703a806

Browse files
author
Bob Grabar
committed
made addition to References section
1 parent d5b88a9 commit 703a806

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

meta.style-guide.rst

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,8 @@ documentation team to contribute to documentation.
2525
**2012-03-21**: Merged in content from the Jargon, and cleaned up
2626
style in light of recent experiences.
2727

28+
**2012-08-10**: Bob proposed an addition to the *Referencing* section.
29+
2830
Naming Conventions
2931
------------------
3032

@@ -146,6 +148,18 @@ Referencing
146148
occurrence of the reference in a section. You should *always*
147149
reference objects, except in section headings.
148150

151+
- Structure references with the *why* first; the link second.
152+
153+
For example, instead of this:
154+
155+
Use the :doc:`/tutorial/convert-replica-set-to-replicated-shard-cluster`
156+
procedure if you have an existing replica set.
157+
158+
Type this:
159+
160+
To deploy a shard cluster for an existing replica set, see
161+
:doc:`/tutorial/convert-replica-set-to-replicated-shard-cluster`.
162+
149163
General Formulations
150164
~~~~~~~~~~~~~~~~~~~~
151165

0 commit comments

Comments
 (0)