diff options
| -rw-r--r-- | docs/README.md | 6 | ||||
| -rw-r--r-- | docs/userdoc.md | 81 |
2 files changed, 87 insertions, 0 deletions
diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 0000000..670da71 --- /dev/null +++ b/docs/README.md @@ -0,0 +1,6 @@ +# The ACIT documentation + +... consists of 2 parts: the user documentation and the admin documentation. +see [userdoc.md](userdoc.md) for the user documentation, and +[admindoc.md](admindoc.md) for the admin documentation. + diff --git a/docs/userdoc.md b/docs/userdoc.md new file mode 100644 index 0000000..85e792e --- /dev/null +++ b/docs/userdoc.md @@ -0,0 +1,81 @@ +# The ACIT user documentation + +Hi, and welcome to the ACIT user documentation. This describes what to do as a +(possibly confused) user of an ACIT instance. + +**If you have been sent here by a link in a bug tracker**, you should know the +following: You are interacting with a piece of software called [ACIT](https://git.vosjedev.net/acit.git/). +ACIT is a bug tracker that also includes discussion support and patch support. +The following document tells you how to use ACIT for your goals. Use the Table +Of Contents to navigate around. + +## TOC +TODO + + +## Quick Info +### How do I create a bug report? +Click the relevant link on the project page, it's the top one. Or send an email +to listed email address. +**Make sure your subject line is filled out,** and your bug report makes sense. + +### How can I start a discussion or ask a question? +See `How do I create a bug report`, except make sure your subjectline starts +with `[DISCUSSION]`. + +### How do I submit a patch? +Use [`git send-email`](https://git-send-email.io/). Use the same email address +as for creating bugs. As long as your subjectline starts with `[PATCH]` (which +`git` should do automatically), ACIT will pick it up and properly apply syntax +highlighting to your email's contents. (note it may accidentally highlight +stuff outside of the diff too...) + +### How do I subscribe to a bug/patch/discussion/project? +The fastest way is to click the `subscribe` link on the relevant page, and send +the email that opens. + +(Un)Subscribing in ACIT happens via email too - ACIT intercepts emails with +either `SUBSCRIBE` or `UNSUBSCRIBE` as the subject and applies the relevant +action to the emailadress used for sending (specifically the one found in the +`From` header, for those using emailaliases). + +### How do I UNsubscribe? +The fastest way is to click the `subscribe` link, and change the subjectline +from `SUBSCRIBE` to `UNSUBSCRIBE`. + +(Un)Subscribing in ACIT happens via email too - ACIT intercepts emails with +either `SUBSCRIBE` or `UNSUBSCRIBE` as the subject and applies the relevant +action to the emailadress used for sending (specifically the one found in the +`From` header, for those using emailaliases). + + +## Thread types +Acit knows 3 types of thread types: `BUG`, `DISCUS`, and `PATCH`. + +- a `BUG` is your regular bug report. +- `DISCUS` is a discussion, which can be used for for example asking questions + and discussing ideas. Discussions still have a status though. +- `PATCH` is a patch. Other platforms may refer to this as a Pull Request. Note + ACIT users should interpret 'patch' in the traditional git way, like the + linux kernel uses patches. + + +## Thread statuses +Threads can have one of 5 different statusses. Meanings for the abbreviations +are given, but it's up to the admin for picking the specific meaning. Most are +(assumed) self-describing though. + +Note these statusses apply to all thread types. Some statusses may not be +usefull to some thread types, in which case meaning is up to the admin. + +- `OPEN`: This thread is still open/ongoing. +- `CLOSED`: This thread is closed/solved/merged. +- `UNCONF`: This thread is unconfirmed. In case of patches, can be used to for + instance signal waiting on the patch author to fix feedback. +- `REJECT`: This thread has been rejected. Mostly makes sense in patches and + feature requests (discussions). +- `UPSTRM`: Upstream. Can be used to signal that this is an upstream problem in + case of forks/downstream packages, so support should be sought elsewhere. + + + |