From 65dfc97fc404befb93e151e0665b04a2a10656d3 Mon Sep 17 00:00:00 2001 From: Tomasz Kolek Date: Wed, 5 Apr 2017 07:53:27 +0200 Subject: [PATCH] integrations doc: Move redmine doc to separate file. --- templates/zerver/integrations/index.html | 82 ------------------- templates/zerver/integrations/redmine.html | 93 ++++++++++++++++++++++ zerver/lib/integrations.py | 2 +- 3 files changed, 94 insertions(+), 83 deletions(-) create mode 100644 templates/zerver/integrations/redmine.html diff --git a/templates/zerver/integrations/index.html b/templates/zerver/integrations/index.html index c367a654d4..2e414971f7 100644 --- a/templates/zerver/integrations/index.html +++ b/templates/zerver/integrations/index.html @@ -116,88 +116,6 @@ {% include 'zerver/integrations/email.html' %} {% endif %} - -
- - -

Get information on new or updated Redmine issues right in - Zulip with our Zulip Redmine plugin! Note: this setup must be - done by a Redmine Administrator.

- -

First, create the stream you'd like to use for Redmine notifications, - and subscribe all interested parties to this stream. We recommend the - name redmine.

- -

Then:

- -
    -
  1. -

    Clone - the Zulip - Redmine plugin repository by running:

    - 
    git clone https://github.com/zulip/zulip-redmine-plugin
    -
    2. -
  2. -

    Follow - the Redmine - plugin installation guide to install - the zulip_redmine plugin directory, which is a - subdirectory of the zulip-redmine-plugin repository - directory. In a nutshell, the steps are:

    -
      -
    1. -

      Copy the zulip_redmine directory to - the plugins directory of your Redmine - instance.

      2. -
    2. -

      Update the Redmine database by running (for Rake 2.X, see the - guide for instructions for older versions):

      - 
      rake redmine:plugins:migrate RAILS_ENV=production
      -
      3. -
    3. -

      Restart your Redmine instance.

      -
      4. -
    -

    The Zulip plugin is now registered with Redmine!

    -
    3. -
  3. -

    On your {{ settings_html|safe }}, create a new Redmine bot.

    -
    4. -
  4. -

    To configure Zulip notification settings that apply to many - projects in one go, in Redmine click the "Administration" link in - the top left. Click the "Plugins" link on the Administration page, - and click the "Configure" link to the right of the Zulip plugin - description. In the "Projects" section, select all projects to which - you want these settings to apply.

    -

    To configure Zulip notifications for a particular Redmine project, - visit the project's Settings page.

    -

    - In either case, fill out zulip server by {{ external_api_path_subdomain }}, - the bot email address, and API key, and the - Zulip stream that should receive notifications. Apply your changes. -

    -
    5. -
  5. -

    To test the plugin, create an issue or update an existing issue in - a Redmine project that has Zulip notifications configured (any - project, if you've configured global settings).

    -
    6. -
- -

Congratulations! You're done!
When you update issues in - Redmine, the team can see these updates in real time in Zulip:

- - - -

- Logos are trademarks of their respective owners. - None of the integrations on this page are created by, - affiliated with, or supported by the companies - represented by the logos. -

-
-

RSS

diff --git a/templates/zerver/integrations/redmine.html b/templates/zerver/integrations/redmine.html new file mode 100644 index 0000000000..b5c01f4f01 --- /dev/null +++ b/templates/zerver/integrations/redmine.html @@ -0,0 +1,93 @@ +

+ Get information on new or updated Redmine issues right in + Zulip with our Zulip Redmine plugin! Note: this setup must be + done by a Redmine Administrator. +

+ +

+ First, create the stream you'd like to use for Redmine notifications, + and subscribe all interested parties to this stream. We recommend the + name redmine. +

+ +

Then:

+ +
    +
  1. +

    + Clone the + + Zulip Redmine plugin repository + + by running: +

    + 
    git clone https://github.com/zulip/zulip-redmine-plugin
    +
    2. +
  2. +

    + Follow the + + Redmine plugin installation guide + + to install the zulip_redmine plugin directory, which is a + subdirectory of the zulip-redmine-plugin repository + directory. In a nutshell, the steps are: +

    +
      +
    1. +

      + Copy the zulip_redmine directory to + the plugins directory of your Redmine + instance. +

      +
      2. +
    2. +

      + Update the Redmine database by running (for Rake 2.X, see the + guide for instructions for older versions): +

      + 
      rake redmine:plugins:migrate RAILS_ENV=production
      +
      3. +
    3. +

      Restart your Redmine instance.

      +
      4. +
    +

    The Zulip plugin is now registered with Redmine!

    +
    3. +
  3. +

    On your {{ settings_html|safe }}, create a new Redmine bot.

    +
    4. +
  4. +

    + To configure Zulip notification settings that apply to many + projects in one go, in Redmine click the "Administration" link in + the top left. Click the "Plugins" link on the Administration page, + and click the "Configure" link to the right of the Zulip plugin + description. In the "Projects" section, select all projects to which + you want these settings to apply. +

    +

    + To configure Zulip notifications for a particular Redmine project, + visit the project's Settings page. +

    +

    + In either case, fill out zulip server by {{ external_api_path_subdomain }}, + the bot email address, and API key, and the + Zulip stream that should receive notifications. Apply your changes. +

    +
    5. +
  5. +

    + To test the plugin, create an issue or update an existing issue in + a Redmine project that has Zulip notifications configured (any + project, if you've configured global settings). +

    +
    6. +
+ +

+ Congratulations! You're done!
When you update issues in + Redmine, the team can see these updates in real time in Zulip: +

+ + diff --git a/zerver/lib/integrations.py b/zerver/lib/integrations.py index f4d23a2a20..14b32ec2e3 100644 --- a/zerver/lib/integrations.py +++ b/zerver/lib/integrations.py @@ -225,7 +225,7 @@ INTEGRATIONS = { 'perforce': Integration('perforce', 'perforce', doc='zerver/integrations/perforce.html'), 'phabricator': Integration('phabricator', 'phabricator', doc='zerver/integrations/phabricator.html'), 'puppet': Integration('puppet', 'puppet', doc='zerver/integrations/puppet.html'), - 'redmine': Integration('redmine', 'redmine'), + 'redmine': Integration('redmine', 'redmine', doc='zerver/integrations/redmine.html'), 'rss': Integration('rss', 'rss', display_name='RSS'), 'subversion': Integration('subversion', 'subversion'), 'trac': Integration('trac', 'trac'),