Version Numbers

On this page

General Guidelines
Identify EOL Releases

Versions are unique names assigned to product releases that are packaged with a set of features at a specific point in time. MongoDB products follow semantic versioning Use version numbers or names to refer to a particular release of a product, such as identifying when a new feature was introduced or removed.

General Guidelines

With the exception of release notes and changelogs, which serve as historical documents, avoid referencing product release versions that we no longer support. For example, when a release of MongoDB Server reaches End of Life (EOL), remove references to that release.

You can omit the following release-specific references:

Features introduced in an EOL release are outdated.
Features removed in an EOL release are unavailable in all supported releases.
Features changed in an EOL release represent preexisting behavior in all supported releases.

Use the following guidelines to reference product versions so that you can more easily find these references when the release reaches EOL:

Use version directives whenever possible. The version directives make it easier to locate on the page and in the reStructuredText:
```
.. versionadded:: 6.0
```
If a version reference needs more explanation, add the content to the directive block:
```
.. versionchanged:: 4.4
   This command returns the following output:
```
If you need to call out multiple versions, set the most recent version first, then reference the others in a phrase afterwards.
```
.. versionadded:: 6.0 *(Also available in MongoDB 5.0.)*
```
The italics marker matches the directive output.
Snooty supports the following version directives:
versionadded
versionchanged
deprecated
To refer to a version inline, include the product name before the version number, (for example, MongoDB 5.0). This ensures that a search for version numbers correctly matches product and release.
Do not reference versions freeform or with the phrase version X.X. These references are much harder to identify programmatically as references to a specific product version.

Identify EOL Releases

You can find references to EOL releases of MonogDB using grep:

$ grep -nRI \
      -e ".. versionadded:: [0-9]" \
      -e ".. versionchanged:: [0-9]" \
      -e ".. deprecated:: [0-9]" \
      -e "MongoDB [0-9]" \
      source | \
      grep -v "6\.2" | \
      grep -v "6\.1" | \
      grep -v "6\.0" | \
      grep -v "5\.3" | \
      grep -v "5\.1" | \
      grep -v "5\.0" | \
      grep -v "4\.4" | \
      grep -v "4\.2" | \
      grep -v "source/release-notes"
source/sharding.txt:128:- In MongoDB 4.0 and earlier, a document's shard key field value is
source/sharding.txt:351:   Starting in MongoDB 4.0.3, setting up zones and zone ranges *before*
source/sharding.txt:379:Starting in MongoDB 3.6, :doc:`change streams </changeStreams>` are
...

Whenever a release goes EOL, remove the relevant grep -v line to ensure that its version references begin to appear in the results.

Back

URLs and Domain Names

Voice and Tone