From 0e13c4bede618e9feaaf70ace2e8098a4d3b9707 Mon Sep 17 00:00:00 2001 From: Adam Coddington Date: Thu, 17 Apr 2014 06:48:04 -0700 Subject: [PATCH] Link common configuration options explicitly. --- docs/service_template.html | 5 +++++ docs/source/common_configuration.rst | 2 ++ docs/source/services/activecollab.rst | 4 ++++ docs/source/services/activecollab2.rst | 4 ++++ docs/source/services/bitbucket.rst | 3 +++ docs/source/services/bugzilla.rst | 4 ++++ docs/source/services/github.rst | 5 +++++ docs/source/services/jira.rst | 5 +++++ docs/source/services/megaplan.rst | 4 ++++ docs/source/services/phabricator.rst | 4 ++++ docs/source/services/redmine.rst | 4 ++++ docs/source/services/teamlab.rst | 4 ++++ docs/source/services/trac.rst | 4 ++++ 13 files changed, 52 insertions(+) diff --git a/docs/service_template.html b/docs/service_template.html index ae430c77e..78cda842b 100644 --- a/docs/service_template.html +++ b/docs/service_template.html @@ -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 ---------------- diff --git a/docs/source/common_configuration.rst b/docs/source/common_configuration.rst index 1fde6a896..60cd423a0 100644 --- a/docs/source/common_configuration.rst +++ b/docs/source/common_configuration.rst @@ -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 ------------------------------------ diff --git a/docs/source/services/activecollab.rst b/docs/source/services/activecollab.rst index 3a54a2084..a39d09bd5 100644 --- a/docs/source/services/activecollab.rst +++ b/docs/source/services/activecollab.rst @@ -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 ------------------- diff --git a/docs/source/services/activecollab2.rst b/docs/source/services/activecollab2.rst index 04e1d34f0..86daed258 100644 --- a/docs/source/services/activecollab2.rst +++ b/docs/source/services/activecollab2.rst @@ -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 ------------------- diff --git a/docs/source/services/bitbucket.rst b/docs/source/services/bitbucket.rst index 4492614a4..3888c0c52 100644 --- a/docs/source/services/bitbucket.rst +++ b/docs/source/services/bitbucket.rst @@ -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 ------------------- diff --git a/docs/source/services/bugzilla.rst b/docs/source/services/bugzilla.rst index 8403a19ec..2aacc3a18 100644 --- a/docs/source/services/bugzilla.rst +++ b/docs/source/services/bugzilla.rst @@ -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 ------------------- diff --git a/docs/source/services/github.rst b/docs/source/services/github.rst index 32ac4fb9a..cab50b064 100644 --- a/docs/source/services/github.rst +++ b/docs/source/services/github.rst @@ -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 ---------------- diff --git a/docs/source/services/jira.rst b/docs/source/services/jira.rst index be58635de..36c414e30 100644 --- a/docs/source/services/jira.rst +++ b/docs/source/services/jira.rst @@ -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 ---------------- diff --git a/docs/source/services/megaplan.rst b/docs/source/services/megaplan.rst index 1674fb4e4..1bfaf5f32 100644 --- a/docs/source/services/megaplan.rst +++ b/docs/source/services/megaplan.rst @@ -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 ------------------- diff --git a/docs/source/services/phabricator.rst b/docs/source/services/phabricator.rst index 861a74301..e33d4c39c 100644 --- a/docs/source/services/phabricator.rst +++ b/docs/source/services/phabricator.rst @@ -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 ------------------- diff --git a/docs/source/services/redmine.rst b/docs/source/services/redmine.rst index 98e774b21..47f2dbc06 100644 --- a/docs/source/services/redmine.rst +++ b/docs/source/services/redmine.rst @@ -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 ------------------- diff --git a/docs/source/services/teamlab.rst b/docs/source/services/teamlab.rst index c2e6671d2..5d4caa023 100644 --- a/docs/source/services/teamlab.rst +++ b/docs/source/services/teamlab.rst @@ -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 ------------------- diff --git a/docs/source/services/trac.rst b/docs/source/services/trac.rst index 2d7a9dd1d..7f1d44157 100644 --- a/docs/source/services/trac.rst +++ b/docs/source/services/trac.rst @@ -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 ----------------