Skip to content

Commit

Permalink
Add getting started section
Browse files Browse the repository at this point in the history
The getting started section will contain basic examples using curl.
This will serve as a basic tutorial to those not familiar with interacting
with rest apis
  • Loading branch information
mjmayer committed Apr 10, 2018
1 parent e4d0c06 commit 58bff73
Show file tree
Hide file tree
Showing 4 changed files with 42 additions and 0 deletions.
9 changes: 9 additions & 0 deletions getting_started/step_by_step/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
Step by Step
============

.. toctree::
:maxdepth: 1
:name: toc-learn-step-by-step

prereq
yougotmail
22 changes: 22 additions & 0 deletions getting_started/step_by_step/prereq.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
.. _doc_curl_prerq
Prerequisites
=============

There are only two programs you need to get started `curl <https://curl.haxx.se/>`_ and
`jq <https://stedolan.github.io/jq/>`_ . If you are using linux or OSX curl is most likely
already installed. The `jq download <https://stedolan.github.io/jq/download/>`_ page provides
installation instructions for most operating systems.

.. code-block:: bash
:caption: For operating systems using yum
$sudo yum install curl jq -y
.. code-block:: bash
:caption: For operating system using apt
$sudo apt-get install jq curl -y
.. tip:: Windows users can use `chocolatey <https://chocolatey.org/>`_ to install jq and curl

4 changes: 4 additions & 0 deletions getting_started/step_by_step/yougotmail.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
.. _doc_yougotmail
You Got Mail!
=============
7 changes: 7 additions & 0 deletions index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,3 +21,10 @@ in the top left corner.
:name: sec-general

about/index

.. toctree::
:maxdepth: 1
:caption: Getting Started
:name: sec-getting_started

getting_started/step_by_step/index

0 comments on commit 58bff73

Please sign in to comment.