Moved the methods of submitting data beneath the top level heading (#2327)

* Moved the methods of submitting data beneath the top level heading

* Replace 'github' and 'Github' with 'GitHub' in documentation

docs/common_tasks.rst

@@ -83,8 +83,8 @@ To add a new repository, the following steps are needed:
 
 * Restart any running gunicorn/celery processes.
 
-For more information on adding a new Github repository
-see :ref:`Add Github repository <add-github-repo>`.
+For more information on adding a new GitHub repository
+see :ref:`Add GitHub repository <add-github-repo>`.
 
 
 Building the docs locally
@@ -112,7 +112,7 @@ cross-domain).
 
 To do this:
 
-* Fork the Treeherder repository to your own Github account.
+* Fork the Treeherder repository to your own GitHub account.
 
 * Create a gh-pages branch locally based on the feature branch you wish to test, that is configured to point at production's API. eg:
 

docs/installation.rst

@@ -13,7 +13,7 @@ Prerequisites
 
 * If you are new to Mozilla or the A-Team, read the `A-Team Bootcamp`_.
 * Install Git_, Virtualbox_ and Vagrant_ (latest versions recommended).
-* Clone the `treeherder repo`_ from Github.
+* Clone the `treeherder repo`_ from GitHub.
 * Windows only: Ensure MSYS ssh (ships with Git for Windows) is on the PATH, so Vagrant can find it (using PuTTY is more hassle).
 * Linux only: An nfsd server is required. You can install this on Ubuntu by running `apt-get install nfs-common nfs-kernel-server`
 

docs/submitting_data.rst

@@ -29,20 +29,20 @@ To submit your test data to Treeherder, you have two options:
 If you are establishing a new repository with Treeherder, then you will need to
 do one of the following:
 
-1. For Github repos: :ref:`add-github-repo`
+1. For GitHub repos: :ref:`add-github-repo`
 
 2. For Mercurial repos: :ref:`add-hg-repo`
 
 
 .. _submitting-using-pulse:
 
-Submitting using Pulse
-======================
+Using Pulse
+-----------
 
 To submit via a Pulse exchange, these are the steps you will need to follow:
 
 1. Format your data
--------------------
+^^^^^^^^^^^^^^^^^^^
 
 You should format your job data according to the `Pulse Job Schema`_,
 which describes the various properties of a job: whether it passed or failed,
@@ -52,7 +52,7 @@ exchange, or Treeherder may reject it.
 
 
 2. Create your Exchange
------------------------
+^^^^^^^^^^^^^^^^^^^^^^^
 
 With `Pulse Guardian`_, you need to create your Pulse User in order to
 create your own Queues and Exchanges.  There is no mechanism to create an
@@ -71,7 +71,7 @@ publisher.
 
 
 3. Register with Treeherder
----------------------------
+^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 Once you have successfully tested a round-trip through your Pulse exchange to
 your development instance, you are ready to have Treeherder receive your data.
@@ -112,7 +112,7 @@ with different routing key settings, or two separate exchanges.  The choice is
 yours.
 
 4. Publish jobs to your Exchange
---------------------------------
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 Once the above config is set on Treeherder, you can begin publishing jobs
 to your Exchange and they will start showing in Treeherder.
@@ -123,8 +123,8 @@ Exchange YOU own.  Treeherder is now just listening to it.
 
 .. _submitting-using-python-client:
 
-Submitting using the Python Client
-==================================
+Using the Python Client
+-----------------------
 
 There are two types of data structures you can submit with the :ref:`Python client
 <python-client>`: job and resultset collections. The client provides methods
@@ -140,9 +140,9 @@ Authentication is covered :ref:`here <authentication>`.
 
 
 Resultset Collections
----------------------
+^^^^^^^^^^^^^^^^^^^^^
 
-Resultset collections contain meta data associated with a github pull request
+Resultset collections contain meta data associated with a GitHub pull request
 or a push to mercurial or any event that requires tests to be run on a
 repository.  The most critical part of each resultset is the `revision`.
 This is used as an identifier to associate test job data with. This is the
@@ -175,7 +175,7 @@ following data structure:
 
 
 Job Collections
----------------
+^^^^^^^^^^^^^^^
 
 Job collections can contain test results from any kind of test. The
 `revision` provided should match the associated `revision` in the
@@ -263,7 +263,7 @@ see :ref:`custom-log-name` for more info.
 
 
 Artifact Collections
---------------------
+^^^^^^^^^^^^^^^^^^^^
 
 Artifact collections contain arbitrary data associated with a job. This is
 usually a json blob of structured data produced by the build system during the
@@ -282,7 +282,7 @@ job execution.
     ]
 
 Usage
------
+^^^^^
 
 If you want to use `TreeherderResultSetCollection` to build up the resultset
 data structures to send, do something like this.
@@ -477,7 +477,7 @@ add them to the collection.
     client.post_collection('mozilla-central', tac)
 
 Job artifacts format
---------------------
+^^^^^^^^^^^^^^^^^^^^
 
 Artifacts can have name, type and blob. The blob property can contain any
 valid data structure accordingly to type attribute.  For example if you use
@@ -581,7 +581,7 @@ will be rendered. Here are the possible values:
 
 
 Some Specific Collection POSTing Rules
---------------------------------------
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 Treeherder will detect what data is submitted in the ``TreeherderCollection``
 and generate the necessary artifacts accordingly.  The outline below describes
@@ -591,7 +591,7 @@ See :ref:`schema_validation` for more info on validating some specialized JSON
 data.
 
 JobCollections
-^^^^^^^^^^^^^^
+~~~~~~~~~~~~~~
 Via the ``/jobs`` endpoint:
 
 1. Submit a Log URL with no ``parse_status`` or ``parse_status`` set to "pending"
@@ -607,7 +607,7 @@ Via the ``/jobs`` endpoint:
 
 
 ArtifactCollections
-^^^^^^^^^^^^^^^^^^^
+~~~~~~~~~~~~~~~~~~~
 Via the ``/artifact`` endpoint:
 
 1. Submit a ``text_log_summary`` artifact
@@ -621,7 +621,7 @@ Via the ``/artifact`` endpoint:
 .. _custom-log-name:
 
 Specifying Custom Log Names
----------------------------
+^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 By default, the Log Viewer expects logs to have the name of ``buildbot_text``
 at this time.  However, if you are supplying the ``text_log_summary`` artifact
@@ -668,11 +668,11 @@ log name.  You must specify the name in two places for this to work.
 
 .. _add-github-repo:
 
-Adding a Github Repository
+Adding a GitHub Repository
 --------------------------
 
-The pushes from Github repos come to Treeherder via Pulse.  The webhook to enable
-this exists in the Github group ``mozilla``. (For example, ``github.com/mozilla/treeherder``)
+The pushes from GitHub repos come to Treeherder via Pulse.  The webhook to enable
+this exists in the GitHub group ``mozilla``. (For example, ``github.com/mozilla/treeherder``)
 
 The following steps are required:
 
@@ -682,7 +682,7 @@ The following steps are required:
 2. Open a bug request to enable the webhook that will trigger pulse messages for
    every push from your repo.  Use the following information:
 
-   a. Component: Github: Administration
+   a. Component: GitHub: Administration
    b. Ask to install the https://github.com/integration/taskcluster integration on your repositories
    c. List the repositories you want to have access to the integration
    d. Answer: Are any of those repositories private?
@@ -696,4 +696,3 @@ The following steps are required:
 .. _MozillaPulse: https://pypi.python.org/pypi/MozillaPulse
 .. _Kombu: https://pypi.python.org/pypi/kombu
 .. _publish_to_pulse: https://github.com/mozilla/treeherder/blob/master/treeherder/etl/management/commands/publish_to_pulse.py#L12-L12
-

docs/ui/installation.rst

@@ -8,7 +8,7 @@ see the Vagrant instructions.
 
 To get started:
 
-* Clone the `treeherder repo`_ from Github.
+* Clone the `treeherder repo`_ from GitHub.
 * Install `Node.js`_ and Yarn_ if not present.
 * Run ``yarn install --no-bin-links`` to install all dependencies.