Skip to content

Commit

Permalink
Link common configuration options explicitly.
Browse files Browse the repository at this point in the history
  • Loading branch information
Adam Coddington committed Apr 17, 2014
1 parent 61f9070 commit 0e13c4b
Show file tree
Hide file tree
Showing 13 changed files with 52 additions and 0 deletions.
5 changes: 5 additions & 0 deletions docs/service_template.html
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,11 @@
[my_issue_tracker]
service = {{ service_name }}

The above example is the minimum required to import issues from
{{ service_name_humane }}. You can also feel free to use any of the
configuration options described in :ref:`common_configuration_options`
or described in `Service Features`_ below.

Service Features
----------------

Expand Down
2 changes: 2 additions & 0 deletions docs/source/common_configuration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,8 @@ Optional options include:

A more-detailed example configuration can be found at :ref:`example_configuration`.

.. _common_configuration_options:

Common Service Configuration Options
------------------------------------

Expand Down
4 changes: 4 additions & 0 deletions docs/source/services/activecollab.rst
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,10 @@ see :ref:`activecollab2` for activeCollab2.x.
activecollab.key = your-api-key
activecollab.user_id = 15

The above example is the minimum required to import issues from
ActiveCollab 3. You can also feel free to use any of the
configuration options described in :ref:`common_configuration_options`.

Provided UDA Fields
-------------------

Expand Down
4 changes: 4 additions & 0 deletions docs/source/services/activecollab2.rst
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,10 @@ with ActiveCollab 2.x - see above for 3.x and greater.
activecollab2.user_id = 15
activecollab2.projects = 1:first_project, 5:another_project

The above example is the minimum required to import issues from
ActiveCollab 2. You can also feel free to use any of the
configuration options described in :ref:`common_configuration_options`.

Provided UDA Fields
-------------------

Expand Down
3 changes: 3 additions & 0 deletions docs/source/services/bitbucket.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,9 @@ Here's an example of an Bitbucket target::
bitbucket.username = ralphbean
bitbucket.password = mypassword

The above example is the minimum required to import issues from
Bitbucket. You can also feel free to use any of the
configuration options described in :ref:`common_configuration_options`.

Provided UDA Fields
-------------------
Expand Down
4 changes: 4 additions & 0 deletions docs/source/services/bugzilla.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,10 @@ make bugwarrior support more robust!
bugzilla.username = rbean@redhat.com
bugzilla.password = OMG_LULZ

The above example is the minimum required to import issues from
Bugzilla. You can also feel free to use any of the
configuration options described in :ref:`common_configuration_options`.

Provided UDA Fields
-------------------

Expand Down
5 changes: 5 additions & 0 deletions docs/source/services/github.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,11 @@ Here's an example of an Github target::
github.login = ralphbean
github.password = OMG_LULZ

The above example is the minimum required to import issues from
Github. You can also feel free to use any of the
configuration options described in :ref:`common_configuration_options`
or described in `Service Features`_ below.

Service Features
----------------

Expand Down
5 changes: 5 additions & 0 deletions docs/source/services/jira.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,11 @@ Here's an example of a jira project::

The ``base_uri`` must not have a trailing slash.

The above example is the minimum required to import issues from
Jira. You can also feel free to use any of the
configuration options described in :ref:`common_configuration_options`
or described in `Service Features`_ below.

Service Features
----------------

Expand Down
4 changes: 4 additions & 0 deletions docs/source/services/megaplan.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,10 @@ Here's an example of an Megaplan target::
megaplan.password = secret
megaplan.project_name = example

The above example is the minimum required to import issues from
Megaplab. You can also feel free to use any of the
configuration options described in :ref:`common_configuration_options`.

Provided UDA Fields
-------------------

Expand Down
4 changes: 4 additions & 0 deletions docs/source/services/phabricator.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,10 @@ Here's an example of an Phabricator target::
to gather information from Phabricator,
but credentials will be gathered from the user's ``~/.arcrc``.

The above example is the minimum required to import issues from
Phabricator. You can also feel free to use any of the
configuration options described in :ref:`common_configuration_options`.

Provided UDA Fields
-------------------

Expand Down
4 changes: 4 additions & 0 deletions docs/source/services/redmine.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,10 @@ Here's an example of an Redmine target::
redmine.user_id = 7
redmine.project_name = redmine

The above example is the minimum required to import issues from
Redmine. You can also feel free to use any of the
configuration options described in :ref:`common_configuration_options`.

Provided UDA Fields
-------------------

Expand Down
4 changes: 4 additions & 0 deletions docs/source/services/teamlab.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,10 @@ Here's an example of an Teamlab target::
teamlab.password = secret
teamlab.project_name = example_teamlab

The above example is the minimum required to import issues from
Teamlab. You can also feel free to use any of the
configuration options described in :ref:`common_configuration_options`.

Provided UDA Fields
-------------------

Expand Down
4 changes: 4 additions & 0 deletions docs/source/services/trac.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,10 @@ Here's an example of an Trac target::
Your Trac installation must have the XML-RPC plugin enabled
for Bugwarrior to work.

The above example is the minimum required to import issues from
Trac. You can also feel free to use any of the
configuration options described in :ref:`common_configuration_options`.

Service Features
----------------

Expand Down

0 comments on commit 0e13c4b

Please sign in to comment.