Skip to content

made addition to References section #118

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 11, 2012
Merged

made addition to References section #118

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions meta.style-guide.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,8 @@ documentation team to contribute to documentation.
**2012-03-21**: Merged in content from the Jargon, and cleaned up
style in light of recent experiences.

**2012-08-10**: Bob proposed an addition to the *Referencing* section.

Naming Conventions
------------------

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

- Structure references with the *why* first; the link second.

For example, instead of this:

Use the :doc:`/tutorial/convert-replica-set-to-replicated-shard-cluster`
procedure if you have an existing replica set.

Type this:

To deploy a shard cluster for an existing replica set, see
:doc:`/tutorial/convert-replica-set-to-replicated-shard-cluster`.

General Formulations
~~~~~~~~~~~~~~~~~~~~

Expand Down