~bzg/woof

24f4ec22dc243eb3d3c9832bd090403fe3cf68ec — Bastien 2 months ago 9ba4cdc
resources/md/howto*: Update
2 files changed, 35 insertions(+), 14 deletions(-)

M resources/md/howto.md
M resources/md/howto.org
M resources/md/howto.md => resources/md/howto.md +34 -13
@@ 58,7 58,7 @@ Actions are declared at the beginning of a line in the reply.
For **bugs**:

-   `Confirmed.` : Confirm a bug.
-   `Fix.` : Mark a bug as fixed.
-   `Fixed.` : Mark a bug as fixed.

For **patches**:



@@ 73,7 73,7 @@ For **help requests**:
For bugs, patches, requests, announcements, changes and releases, you
can also cancel them:

-   `Canceled`. : Mark the bug, patch, request, announcement, change or
-   `Canceled.` : Mark the bug, patch, request, announcement, change or
    release as canceled.

**Note**: A punctuation mark among `;:,.` is *mandatory* for these reports and


@@ 92,17 92,20 @@ mailbox with this command at the beginning of a line:
-   `Notifications: false` : To turn notifications off
-   `Notifications: true` : To turn notifications on

Admins can turn notifications globally on and off with

# Admins and maintainers
-   `Global notifications: [true|false]`


# Admins

Each Woof! instance comes with a default admin.

**Admins** can update the main configuration:

-   `Global notifications: [true|false]` : Enable/disable mail notifications globally
-   `Maintenance: [true|false]` : Put the website in maintenance mode
-   `Notifications: [true|false]` : Enable/disable mail notifications globally
-   `Set theme: my_theme` : Use `my_theme` for the interface
-   `[Add|Remove] admin: woof@woof.io` : Add or remove an admin
-   `[Add|Remove] feature: feature` : Add or remove a feature
-   `[Add|Remove] export: format` : Add or remove an export format



@@ 111,7 114,12 @@ In these actions:
-   `feature` can be `bug`, `announcement`, `request`, `change`, `release` or `mail`.
-   `format` can be `rss`, `json`, `org` or `md`.

Admins can also *delete* past reports and *ignore* future mails:
They can also add or remove admins and maintainers:

-   `[Add|Remove] admin: woof@woof.io` : Add or remove an admin
-   `[Add|Remove] maintainer: woof@woof.io` : Add or remove a maintainer

Finally, admins can also *delete* past reports and *ignore* future mails:

-   `[Delete|Undelete]: woof@woof.io`
-   `[Ignore|Unignore]: woof@woof.io`


@@ 120,26 128,39 @@ Remember: deletion is for cleaning up past reports, ignoring is about
future emails.  When plugging Woof! to a mailing list, first consider
moderating users instead of ignoring them.

**Maintainers** can perform these actions:
`Add/Remove` commands and `(Un)Delete/(Un)Ignore` commands accept several
arguments: you can use `Add feature: bug top` to add both the "bug" and
"top" features, or `Ignore: user1@woof.io user2@woof.io` to ignore
future messages from these users.


# Maintainers

**Maintainers** can perform three actions:

-   `Add maintainer: woof@woof.io`
-   `Delete: woof@woof.io`
-   `Ignore: woof@woof.io`

New maintainers receive a mail notification.
When contributors are promoted as maintainers, they receive a
notification by email.

Note that maintainers cannot remove admins or other maintainers and
they cannot undelete mails or unignore contributors.

Admins and maintainers can send several commands in a mail, with each
starting at the beginning of a line.  For example, an email with:

# Sending multiple commands

One can send several commands in a mail, with each command starting at
the beginning of a line.  For example, an email with:

    Set theme: my_theme
    Add maintainer: my@friend.io
    Add maintainer: my@friend.io myother@friend.io
    Ignore: my@enemy.io

will set the theme "my\_theme", add "my@friend.io" as a new maintainer
and ignore future reports by "my@enemy.io".
will set the theme "my\_theme", add "my@friend.io" and
"myother@friend.io" as maintainers and ignore future reports by
"my@enemy.io".


# Woof without a mailing list

M resources/md/howto.org => resources/md/howto.org +1 -1
@@ 57,7 57,7 @@ Actions are declared at the beginning of a line in the reply.
For *bugs*:

- =Confirmed.= : Confirm a bug.
- =Fix.= : Mark a bug as fixed.
- =Fixed.= : Mark a bug as fixed.

For *patches*: