Skip to content

Commit

Permalink
Update Docs
Browse files Browse the repository at this point in the history
  • Loading branch information
preciousplum committed Apr 24, 2022
1 parent d69d612 commit bc2c33d
Show file tree
Hide file tree
Showing 3 changed files with 95 additions and 87 deletions.
88 changes: 46 additions & 42 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,42 +1,46 @@
# Expand Custom Users as Assignees plugin
[日本語](README_Ja.md)

Redmine plugin for adding assignee functionality includes default query and reminder to **Custom Users**.
*) **Custom Users** means the users specified in the **Custom field** of the **User** format

This plugin can realize multiple assignees on issues for review tasks by multiple people use case and so on.
* send email notifications to **Custom Users who are added or removed** on issues, or all **Custom Users** as broadcast when **Custom Users** are not changed on issues, as well as authors and assignees.
* send reminder to users set in **Custom Users** on issues
* issues that **Custom Users** are listed on are queried as assignees such as **"My page" > "Issues assigned to me"**
*) Use "just Assignee" field instead to proceed query by the original scope of "assignee".

## Installation

1. To install the plugin

`git clone` to `plugins/custom_users_as_assignees` on your Redmine path.

$ cd {RAILS_ROOT}/plugins
$ git clone https://github.com/preciousplum/custom_users_as_assignees

2. Restart Redmine.

Now you should be able to see the plugin in **Administration > Plugins**.
*) Migration is **not** required.

## Compatibility
This plugin version is compatible with Redmine 3.3.0 and later in principle.
However, this plugin has been tested on Redmine 4.0.3 and 4.2.5 only currently.

## Special Thanks
This plugin was developed based on notify_custom_users plugin.
https://github.com/Restream/notify_custom_users

## Screen Images
Here are the images used with customfield_checkbox_utility plugin. https://github.com/preciousplum/customfield_checkbox_utility

![Custom Field Setting](assets/images/custom_field_setting.png)
![Edit Issue](assets/images/edit_issue.png)
![Assigned to me](assets/images/assigned_to_me.png)
![Notification](assets/images/notification.png)
![Reminder](assets/images/reminder.png)
# Expand Custom Users as Assignees plugin for Multiple Assignees
[日本語](README_Ja.md)

Redmine plugin for adding assignee functionality includes default query and reminder to **Custom Users**.
*) **Custom Users** means the users specified in the **Custom field** of the **User** format

This plugin can realize multiple assignees on issues for review tasks by multiple people use case and so on.
* send email notifications to **Custom Users who are added or removed** on issues, or all **Custom Users** as broadcast when **Custom Users** are not changed on issues, as well as authors and assignees.
* send reminder to users set in **Custom Users** on issues
* issues that **Custom Users** are listed on are queried as assignees such as **"My page" > "Issues assigned to me"**
*) Use "just Assignee" field instead to proceed query by the original scope of "assignee".

## Use Case Image
![Custom Field Setting](assets/images/usecase.png)
The recommended operation is keeping a ticket manager in the original Assignee separated from Custom Users assignment.

## Installation

1. To install the plugin

`git clone` to `plugins/custom_users_as_assignees` on your Redmine path.

$ cd {RAILS_ROOT}/plugins
$ git clone https://github.com/preciousplum/custom_users_as_assignees

2. Restart Redmine.

Now you should be able to see the plugin in **Administration > Plugins**.
*) Migration is **not** required.

## Compatibility
This plugin version is compatible with Redmine 3.3.0 and later in principle.
However, this plugin has been tested on Redmine 4.0.3 and 4.2.5 only currently.

## Special Thanks
This plugin was developed based on notify_custom_users plugin.
https://github.com/Restream/notify_custom_users

## Screen Images
Here are the images used with customfield_checkbox_utility plugin. https://github.com/preciousplum/customfield_checkbox_utility

![Custom Field Setting](assets/images/custom_field_setting.png)
![Edit Issue](assets/images/edit_issue.png)
![Assigned to me](assets/images/assigned_to_me.png)
![Notification](assets/images/notification.png)
![Reminder](assets/images/reminder.png)
94 changes: 49 additions & 45 deletions README_Ja.md
Original file line number Diff line number Diff line change
@@ -1,45 +1,49 @@
# カスタムフィールドユーザの担当者化プラグイン
[English](README.md)

カスタムフィールドユーザにデフォルトクエリでの紹介やリマインダーメール送信する機能を追加するプラグインです。
※「カスタムフィールドユーザ」とは、「ユーザ」フォーマットの「カスタムフィールド」で指定したユーザを指します。

レビューなど複数の作業者で同時進行するユースケースに必要な複数の担当者指定を実現できます。
* カスタムフィールドユーザがチケットに追加また削除されたときに、そのユーザにメール通知されます。
チケット更新時、カスタムフィールドユーザに変更がない場合は、全カスタムフィールドユーザにもメール通知されます。(本来の動作としていずれの場合も作成者や担当者にも通知されます。)
* カスタムフィールドユーザにもリマインダーメールが送信されます。
* 「担当者」で指定された場合と同様に、チケットが検索されます。
例:「マイページ」>「担当しているチケット」
※元の「担当者」で検索したい場合は、"「担当者」のみ"のフィールドで検索してください。

## インストール方法

1. プラグインのインストール

実行環境のRedmineパスの`plugins/custom_users_as_assignees`に対して`git clone`を実行してください。

$ cd {RAILS_ROOT}/plugins
$ git clone https://github.com/preciousplum/custom_users_as_assignees

2. Redmineの再起動

再起動後 **管理 > プラグイン** でこのプラグインが表示されます。
*) データベースのマイグレーションは必要ありません。

## 互換性
原理的には、このプラグインはRedmine 3.3.0以降に対して互換性があります。
ただし、現状Redmine 4.0.3 と 4.2.5 でしか動作確認されていません。

## 謝辞
このプラグインは notify_custom_users プラグインを元に開発しています。
https://github.com/Restream/notify_custom_users

## 画面イメージ
customfield_checkbox_utilityプラグインとともに使用した画面イメージです。
https://github.com/preciousplum/customfield_checkbox_utility

![カスタムフィールド設定](assets/images/custom_field_setting.png)
![チケット編集](assets/images/edit_issue.png)
![担当チケット](assets/images/assigned_to_me.png)
![通知メール](assets/images/notification.png)
![リマインダーメール](assets/images/reminder.png)
# 複数担当者化:カスタムフィールドユーザの担当者化プラグイン
[English](README.md)

カスタムフィールドユーザにデフォルトクエリでの紹介やリマインダーメール送信する機能を追加するプラグインです。
※「カスタムフィールドユーザ」とは、「ユーザ」フォーマットの「カスタムフィールド」で指定したユーザを指します。

レビューなど複数の作業者で同時進行するユースケースに必要な複数の担当者指定を実現できます。
* カスタムフィールドユーザがチケットに追加また削除されたときに、そのユーザにメール通知されます。
チケット更新時、カスタムフィールドユーザに変更がない場合は、全カスタムフィールドユーザにもメール通知されます。(本来の動作としていずれの場合も作成者や担当者にも通知されます。)
* カスタムフィールドユーザにもリマインダーメールが送信されます。
* 「担当者」で指定された場合と同様に、チケットが検索されます。
例:「マイページ」>「担当しているチケット」
※元の「担当者」で検索したい場合は、"「担当者」のみ"のフィールドで検索してください。

## 運用イメージ
![Custom Field Setting](assets/images/usecase.png)
オリジナルの担当者欄にはチケット管理者として割り当て、チケット管理者が複数の「カスタムフィールドユーザ」を割り当て・管理する運用をお勧めします。

## インストール方法

1. プラグインのインストール

実行環境のRedmineパスの`plugins/custom_users_as_assignees`に対して`git clone`を実行してください。

$ cd {RAILS_ROOT}/plugins
$ git clone https://github.com/preciousplum/custom_users_as_assignees

2. Redmineの再起動

再起動後 **管理 > プラグイン** でこのプラグインが表示されます。
*) データベースのマイグレーションは必要ありません。

## 互換性
原理的には、このプラグインはRedmine 3.3.0以降に対して互換性があります。
ただし、現状Redmine 4.0.3 と 4.2.5 でしか動作確認されていません。

## 謝辞
このプラグインは notify_custom_users プラグインを元に開発しています。
https://github.com/Restream/notify_custom_users

## 画面イメージ
customfield_checkbox_utilityプラグインとともに使用した画面イメージです。
https://github.com/preciousplum/customfield_checkbox_utility

![カスタムフィールド設定](assets/images/custom_field_setting.png)
![チケット編集](assets/images/edit_issue.png)
![担当チケット](assets/images/assigned_to_me.png)
![通知メール](assets/images/notification.png)
![リマインダーメール](assets/images/reminder.png)
Binary file added assets/images/usecase.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit bc2c33d

Please sign in to comment.