Merge pull request #12 from skerschb/admonishment

warning about redirects

Author: skerschb

source/includes/steps-install.yaml

@@ -0,0 +1,67 @@
+title: "Install Xcode from the App Store."
+ref: install-xcode
+content: |
+  
+  Install Xcode. This installation may take awhile. In the meantime, you can follow the rest of the steps.
+
+---
+title: Download and install Homebrew
+ref: install-homebrew
+content: |
+
+  If homebrew is not installed, download it `here <https://brew.sh>`_.
+
+  Then run:
+
+  .. code-block:: sh 
+   
+     /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
+  
+  When this completes, run the following two commands:
+
+  .. code-block:: sh
+
+     brew update 
+     brew doctor
+
+---
+title: Install Python 2 and Python 3
+ref: install-python
+content: |
+  
+  To run the build tools you need both python and python 2. Install them both by running:
+
+  .. code-block:: sh
+
+     brew install python python2
+
+  You also need Pip, the Python package manager. Note you may need to run this in a new shell:
+
+  .. code-block:: sh
+     
+     easy_install pip
+
+---
+title: Install Giza and Mut
+ref: install-giza
+content: |
+  
+  Install the Python modules that Giza requires:
+
+  .. code-block:: sh
+ 
+     python2 -m pip install requests virtualenv virtualenvwrapper jira py-dateutil
+
+  Install Giza:
+
+  .. code-block:: sh 
+     
+     python2 -m pip install giza
+
+  After Giza installation is complete, install Mut:
+
+  .. code-block:: sh
+
+     bash -c "$(curl -fsSL https://raw.githubusercontent.com/mongodb/mut/master/install.sh)"
+     
+...

source/includes/steps-repo.yaml

@@ -101,7 +101,7 @@ content: |
   Create the repo you would like to use on GitHub.
 
   You will then need to commit some files and add your local repository to github. If you add all of the files, you will
-  nned to remove the ones that are not relevant to your repository later, but this is a perfectly acceptable way to start your repository.
+  need to remove the ones that are not relevant to your repository later, but this is a perfectly acceptable way to start your repository.
 
   Make sure you add a README.md file to your repo. Add a sentence to the file to describe your project. Then save the file and run:
 
@@ -133,7 +133,22 @@ content: |
   .. code-block:: sh
 
      git remote add upstream https://github.com/<repoOwner>/<remoteRepoRoot>.git
+---
+title: Remove the redirects file
+ref: remove-redirects
+content: |
+
+  Some of our repositories have a ``redirects`` file that redirects browsers permanently to a new location.
+
+  Please remove the file in order to prevent inadvertant redirects on your site.
+
+  In the config directory of your repo, run:
+
+  .. code-block:: sh
 
+     rm redirects
+
+  
 ---
 title: Edit conf.py
 ref: edit-confpy 
@@ -186,7 +201,7 @@ title: Install Build Tools
 ref: install-build
 content: |
 
-  You will need to `install the build tools <https://gist.github.com/atsansone/aa6b793da9ca30fe7d46#install-the-documentation-software>`_ in order to build your repository.
+  You will need to :doc:`install the build tools </tutorials/install>` in order to build your repository.
 
   Once you have installed the build tools, you can attempt to build your repository.
 
@@ -203,14 +218,4 @@ content: |
 
   You will see output pertaining to your build in the ``build/<branch>`` directory local to your repository.
 
----
-title: Deploying Your Site
-ref: edit-makefile
-content: |
-
-  If you wish to deploy your site to ``mongodb.com`` and leverage the existing staging servers. you will `need to request a token 
-  <https://gist.github.com/atsansone/aa6b793da9ca30fe7d46#systems-authentication-and-authorization>`_ to be able to publish to the S3 buckets.
-
-  Modify the fields in the Makefile that pertain to the location of your deployed site if you wish to do so.
-
 ...

source/tutorials.txt

@@ -11,5 +11,6 @@ Tutorials
    /tutorials/version-bumping
    /tutorials/generating-a-browser-list
    /error-kb
+   /tutorials/install 
    /tutorials/repo
    /tutorials/guide

source/tutorials/install.txt

@@ -0,0 +1,24 @@
+.. guide::
+   title: Installing MongoDB Documentation Build Tools
+   author: MongoDB Documentation Team
+   type: Deep Dive 
+   level: intermediate 
+   product_version: 4.0
+   result_description:
+     In this guide you will learn how to install the MongoDB Documentation Build Tools. Note that this guide only applies to macOS.
+   time: 45
+   prerequisites:
+     - Access to git
+   check_your_environment:
+     - Check to make sure you have git installed
+   procedure:
+     .. include:: /includes/steps/install.rst
+   summary:
+     If you have successfully completed this guide, you have 
+     installed the MongoDB Build Tools.
+   whats_next:
+     Congratulations! Now that you've installed the Build Tools, you are ready to start building your site.
+   seealso:
+     - `check out the guides site for examples <http://docs.mongodb.com/guides>`__.
+     - :doc:`Tabbed Content Tutorial </tutorials/tabbed-content>`
+     - :doc:`Create a Docstools-Enabled Repo </tutorials/repo>`

source/tutorials/repo.txt

@@ -8,9 +8,9 @@
      In this guide you will learn how to create a docstools-enabled repository.
    time: 45
    prerequisites:
-     - access to git
+     - Access to git
    check_your_environment:
-     - check to make sure you have git installed
+     - Check to make sure you have git installed
    procedure:
      .. include:: /includes/steps/repo.rst
    summary: