Skip to content

Template for tutorials #1375

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.

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

Closed
wants to merge 2 commits into from
Closed
Changes from all commits
Commits
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
47 changes: 47 additions & 0 deletions source/tutorial/tutorial-template.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
=================
Tutorial Template
=================

.. Tutorial titles use a verb: "verb something for a goal"

.. default-domain:: mongodb

Overview
--------

.. As appropriate, contains the following:

.. - What are the indications for this tutorial? In what situation does one use it?

.. - What does the tutorial accomplish?

.. - Links to relevant conceptual docs.

.. NOTE: For this section, what's needed will vary greatly from tutorial to tutorial.
Write what's needed. Write well!

Considerations
--------------

.. Use the "Considerations" section in cases where indications are complex or contraindications
need mention. This section is analogous to the "Behavior" section in reference pages.

Prerequisites
-------------

.. Some examples:

.. To create this role, you must have :authaction:`createRole` access.

.. To perform this procedure on a sharded cluster, you must authenticate via a :program:`mongos`.

Procedure
---------

.. Steps. Each step has a header and an explanation.
For example:

.. Create the Role
.. ~~~~~~~~~~~~~~~
..
.. To create the role, use the :dbcommand:`createRole` command. ...