diff --git a/docs/en/delete_content.md b/docs/en/delete_content.md new file mode 100644 index 0000000..cebc76b --- /dev/null +++ b/docs/en/delete_content.md @@ -0,0 +1,32 @@ +# Deleting content +Deleting content on Agorakit follows a procedure that allows us to respond to various imperatives: + +- everyone's right to delete his or her productions +- the right to change one's mind within a certain period of time +- the right to change one's mind for a certain period of time +- to keep collective contributions in the event of a participant's departure. + + +When content is deleted, it is marked as deleted in the database and no longer appears. An instance administrator can put deleted content back online by going to the "admin > retrieve content" menu. + +Content marked as deleted is permanently deleted (physically) from the database after 30 days. It is no longer possible to recover content after this period. + + +# User account deletion +If a user decides to delete their account, they can choose to : + +- anonymize their content (all content is transferred to an anonymous user) +- request that all their content be deleted. + +Discussions with comments are in all cases assigned to the anonymous user, so as not to lose the contributions of other users. +It is not possible to individually delete a thread with comments. + +A user who is the sole administrator of a group cannot leave the group. + + +# Restoring a deleted item +An instance administrator can restore any content deleted during the retention period (30 days by default). Simply go to `Admin > settings > recover content` and select the item(s) to be restored. + +# Cleaning the database +If Agorakit is installed correctly (with recurring cron jobs), the database will be automatically cleaned to comply with the above. +The number of days of data retention before final deletion is configurable and set at 30 by default. \ No newline at end of file diff --git a/docs/en/group.md b/docs/en/group.md index b273fa9..2e367eb 100644 --- a/docs/en/group.md +++ b/docs/en/group.md @@ -4,11 +4,16 @@ Create one or more groups. A welcome and a test group are often useful. -You can choose the type of group to create +Depending on the type of community you want to create, there are several different types of group available. -- An open group has public content and is open to memberships -- A private group has private content and membership is invite only (admin need to accept new members) -- A secret group is not shown anywhere except to existing members. Perfect for your next plot :-) +### Public groups +These groups are open to everyone, and their content is public. Anyone can create an account on the instance and join a public group. A small planet icon is displayed next to the group name. + +### Private groups +These groups are by invitation only and their content is not public. Only the group's presentation page (including group photo and description text) is visible. If the group authorizes users to apply, a tab allows them to do so. A small padlock icon is displayed next to the name. + +### Secret groups +These groups are completely invisible to those who don't know they exist. If you haven't been invited to one, you won't have access to it. A small crossed-out eye icon is displayed next to the name. !!! note Future releases of Agorakit might include more granular control of group types and membership access. Your input is valuable to further enhance this part. diff --git a/docs/en/tags.md b/docs/en/tags.md new file mode 100644 index 0000000..97b795e --- /dev/null +++ b/docs/en/tags.md @@ -0,0 +1,27 @@ +# What are tags and what are they for? + +Classifying content is a science. It's called taxonomy. It can also be hellish, especially when several people are working on the same file. + +> Where is the last PV? +> In /first-quarter/meetings/2021 +> or in /2021/first-quarter/pv? +> or in admin/pv/2021? + +This type of question frequently arises when a group of people file different documents in a hierarchical folder structure. As each person has his or her own filing logic, documents quickly become scattered and very difficult to find. + +Agorakit's solution is to use tags (or keywords) to classify content. These consist of simple keywords that can be applied to the content. The advantage is that you can invent a simple vocabulary, possibly limited to a few keywords, and without a hierarchy that would depend too much on the classification logic of each individual. + +INFO: For example, a PV dated 2021 will simply be tagged `PV` and `2021` and will be very easy to find later. + +Tags can be applied to people, groups, discussions, events and files. + +Clicking on a tag allows you to see all other items tagged in the same way. + +INFO: If you prefer, you can also sort files by folder. A combination of both systems is also possible. It's up to you to see what works best for your group. + +## Limiting the tags you can use +But tags don't solve everything. If your group is large or you have a lot of content, it's possible that at some point you'll find yourself with too many different, non-standardized tags. + +In this case, it's best to think for a moment about which tags are really necessary and to limit the tags available in your group. You can easily do this by going to your group settings (`Manage > Tags`). + +The same goes for users and groups. To standardize people's profiles and, above all, to enable everyone to find someone based on keywords common to all, you can limit the tags usable in user profiles in the `Admin > Settings` menu. diff --git a/docs/en/usage.md b/docs/en/usage.md index 34f3c8d..4c94e3a 100644 --- a/docs/en/usage.md +++ b/docs/en/usage.md @@ -1,12 +1,25 @@ # Using Agorakit + ## Start discussions -Each group allows one to create discussions. Within discussions and comments, you can use a special syntax to reference existing files and discussions, and mention users. +Each group allows you to create discussions. In discussions and comments, you can use special syntax to refer to existing files and discussions, and mention users. + +Choose a group and from the "Discussions" tab you can "Create a discussion". Mention a title and text as a minimum. You can also add keywords or tags to better classify discussions and help others find their way around. + +- Just type @ to mention someone (autocomplete appears). + +You can also attach a file directly to a discussion. Use the "Browse..." button below the discussion form to download a file from your computer, attach it to the group and mention it in the discussion all at once. + + +### Attach a file +In the text editor, you can attach a file by dragging and dropping it, or by clicking on the "image" button, which allows you to insert not only an image, but any type of file. When you drag and drop a file, the system automatically sends your file and inserts a reference to it at the cursor position, in the form of an f:xx (xx being the file reference). When your discussion or comment is displayed, a preview of the file is automatically generated. + +The file also appears in your group's "files" tab. -- Just start typing @ to mention someone (autocomplete appears) +### Mention another person +Simply type @ in the text editor, and a list of group members will appear, allowing you to mention one or more people. They'll instantly receive an e-mail with your comment. Handy when you need a quick answer to your question. -You may also directly attach a file to a discussion. Use the "Browse..." button below the discussion form to upload a file from your computer, attach it to the group, and mention it in the discussion in one go. ## Schedule events diff --git a/docs/en/users.md b/docs/en/users.md new file mode 100644 index 0000000..321f6e0 --- /dev/null +++ b/docs/en/users.md @@ -0,0 +1,40 @@ +# User types + +Agorakit offers different types of user. Here they are, in order of permissions, from the most extensive to the most restricted: + +## Instance administrator +A user with full access rights to an Agorakit instance (installation). This person can do everything: +- access all groups, including secret groups +- modify installation settings +- modify and delete any content + + +## Group administrator +Anyone who creates a group automatically becomes its administrator. This allows you to : +- modify group settings, including member permissions +- access the complete list of participants, including e-mail addresses +- promote any member to admin status +- change any member's status, including removal from the group +- modify and delete any group content + +## Group member +Any member of a group has at least the right to view all group content. They may also, depending on the permissions defined for the group in question : +- create discussions +- create calendar events +- add files +- invite new participants + +## Guest member +In the case of a closed group: when a user has been invited by e-mail to join a group, he receives guest status. As soon as he confirms the request, he becomes an effective member of the group. + +## Group applicant +When a person requests to join a closed group, they are given candidate status. One of the group administrators must accept or reject the application. + +## De-registered / deleted +This status is assigned to people who have deleted their account from the Agorakit instance. + +## Refused +This status is assigned to people who have declined an invitation to join the group. We strongly advise you not to contact them again about the group, as they wish, unless of course it's a false move on their part :-) + +## Blacklisted +This status is assigned to a person who can no longer join the group. \ No newline at end of file diff --git a/docs/fr/discussions.md b/docs/fr/discussions.md deleted file mode 100644 index 15a4804..0000000 --- a/docs/fr/discussions.md +++ /dev/null @@ -1,17 +0,0 @@ -# Créer des discussions - -Choisissez un groupe et depuis l'onglet "Discussions" vous pouvez "Créer une discussion". Mentionnez un titre et un texte au minimum. Vous pouvez aussi ajouter des mots clé ou tags afin de mieux classer les discussions et aider les autres à s'y retrouver. - -## Joindre un fichier -Dans l'éditeur de texte, vous pouvez joindre un fichier en le faisant glisser dessus ou en cliquant sur le bouton "image" qui permet non seulement d'insérer une image mais également tout type de fichier. Lors d'un "drag and drop" (glissé déposé de fichier), le système envoit automatiquement votre fichier et insère là où se trouve votre curseur une référence à ce fichier sous la forme d'un f:xx (xx étant la référence de votre fichier). Lors de l'affichage de votre discussion ou de votre commentaire, un apperçu du fichier sera automatiquement généré. - -Le fichier apparait également dans l'onbglet "fichiers" de votre groupe. - -## Mentionner une autre personne -Dans l'éditeur de texte, tapez simplement un @ , une liste des membres du groupe apparait et vous permet de mentionner une ou plusieurs personnes. Celles-ci recevront un mail instantanément avec votre commentaire. C'est pratique quand vous souhaitez avoir une réponse rapide à votre question. - -## Effacer un commentaire ou une discussion -Cliquez simplement sur les troios petits points à droite de la discussion ou du commentaire en question : (...) et choisissez l'option "Effacer". -L'auteur.e d'un message peut toujours l'effacer. Un.e admin de groupe peux tout effacer. - -WARNING: Le fait d'effacer une discussion n'efface pas les fichiers joints à cette discussion. \ No newline at end of file diff --git a/docs/fr/group.md b/docs/fr/group.md index 476ccc0..8bbeac2 100644 --- a/docs/fr/group.md +++ b/docs/fr/group.md @@ -4,14 +4,20 @@ Créez un ou plusieurs groupes. Un groupe de bienvenue et un groupe de test sont souvent utiles. -Vous pouvez choisir le type de groupe à créer +En fonction du type de communauté que vous souhaitez créer, vous avez à votre disposition différents types de groupes. -- Un groupe ouvert a un contenu public et est ouvert aux adhésions -- Un groupe privé a un contenu privé et l'adhésion se fait uniquement sur invitation (l'administrateur doit accepter les nouveaux membres). -- Un groupe secret n'est visible que par les membres existants. Parfait pour votre prochaine intrigue :-) +### Les groupes publics +Ces groupes sont ouverts à tout le monde, et leur contenu est public. N'importe qui peut se créer un compte sur l'instance et rejoindre un groupe public. Une petite icône de planète est affichée à côté du nom. + +### Les groupes privés +Ces groupes sont sur invitation uniquement et leur contenu n'est pas public. Seul est visible la pag de présentation du groupe (comprenant la photo du groupe et le texte de description). Si le groupe autorise les utilisateurs à candidater, un onglet permet de le faire. Une petite icône de cadenas est affichée à côté du nom. + +### Les groupes secrets +Ces groupes sont totalement invisibles pour celles et ceux qui n'en connaissent pas l'existence. Si vous n'êtes pas invité à un tel groupe vous n'y avez pas accès. Une petite icône d'oeuil barré est affichée à côté du nom. + + +NOTE: Les prochaines versions d'Agorakit pourraient inclure un contrôle plus granulaire des types de groupes et de l'accès aux membres. Votre contribution est précieuse pour améliorer cette partie. -! !! note - Les prochaines versions d'Agorakit pourraient inclure un contrôle plus granulaire des types de groupes et de l'accès aux membres. Votre contribution est précieuse pour améliorer cette partie. ## Paramètres du groupe Si vous êtes administrateur d'un groupe, vous aurez un onglet "admin" sur le(s) groupe(s) que vous gérez. Vous pouvez y gérer beaucoup de choses dans votre groupe. @@ -25,8 +31,7 @@ Ce menu vous permet de choisir la stratégie de marquage que vous souhaitez pour - Balisage libre : tout le monde peut baliser le contenu avec n'importe quelle étiquette. - Tagging contrôlé : vous décidez quels tags sont autorisés dans votre groupe. -! !! note - Bien que le balisage libre soit agréable, il est souvent préférable de se fixer ensemble un ensemble de balises et de s'y tenir dans votre groupe. "Moins c'est plus" et "chacun a une façon différente d'organiser le contenu, alors tenons-nous en à une seule façon de le faire". +NOTE: Bien que le balisage libre soit agréable, il est souvent préférable de se fixer ensemble un ensemble de balises et de s'y tenir dans votre groupe. "Moins c'est plus" et "chacun a une façon différente d'organiser le contenu, alors tenons-nous en à une seule façon de le faire". Les administrateurs de groupe peuvent également définir des couleurs pour les balises. Les couleurs sont partagées entre les groupes. diff --git a/docs/fr/groups_types.md b/docs/fr/groups_types.md deleted file mode 100644 index a14801d..0000000 --- a/docs/fr/groups_types.md +++ /dev/null @@ -1,12 +0,0 @@ -# Les différents types de groupes disponible dans Agorakit - -En fonction du type de communauté que vous souhaitez créer, vous avez à votre disposition différents types de groupes. - -## Les groupes publics -Ces groupes sont ouverts à tout le monde, et leur contenu est public. N'importe qui peut se créer un compte sur l'instance et rejoindre un groupe public. Une petite icône de planète est affichée à côté du nom. - -## Les groupes privés -Ces groupes sont sur invitation uniquement et leur contenu n'est pas public. Seul est visible la pag de présentation du groupe (comprenant la photo du groupe et le texte de description). Si le groupe autorise les utilisateurs à candidater, un onglet permet de le faire. Une petite icône de cadenas est affichée à côté du nom. - -## Les groupes secrets -Ces groupes sont totalement invisibles pour celles et ceux qui n'en connaissent pas l'existence. Si vous n'êtes pas invité à un tel groupe vous n'y avez pas accès. Une petite icône d'oeuil barré est affichée à côté du nom. \ No newline at end of file diff --git a/docs/fr/usage.md b/docs/fr/usage.md index 44fc553..7b39edb 100644 --- a/docs/fr/usage.md +++ b/docs/fr/usage.md @@ -4,10 +4,27 @@ Chaque groupe permet de créer des discussions. Dans les discussions et les commentaires, vous pouvez utiliser une syntaxe spéciale pour faire référence à des fichiers et des discussions existants, et mentionner des utilisateurs. +Choisissez un groupe et depuis l'onglet "Discussions" vous pouvez "Créer une discussion". Mentionnez un titre et un texte au minimum. Vous pouvez aussi ajouter des mots clé ou tags afin de mieux classer les discussions et aider les autres à s'y retrouver. + - Il suffit de taper @ pour mentionner quelqu'un (l'autocomplétion apparaît). Vous pouvez également joindre directement un fichier à une discussion. Utilisez le bouton "Parcourir..." situé sous le formulaire de discussion pour télécharger un fichier depuis votre ordinateur, le joindre au groupe et le mentionner dans la discussion en une seule fois. + +### Joindre un fichier +Dans l'éditeur de texte, vous pouvez joindre un fichier en le faisant glisser dessus ou en cliquant sur le bouton "image" qui permet non seulement d'insérer une image mais également tout type de fichier. Lors d'un "drag and drop" (glissé déposé de fichier), le système envoit automatiquement votre fichier et insère là où se trouve votre curseur une référence à ce fichier sous la forme d'un f:xx (xx étant la référence de votre fichier). Lors de l'affichage de votre discussion ou de votre commentaire, un apperçu du fichier sera automatiquement généré. + +Le fichier apparait également dans l'onbglet "fichiers" de votre groupe. + +### Mentionner une autre personne +Dans l'éditeur de texte, tapez simplement un @ , une liste des membres du groupe apparait et vous permet de mentionner une ou plusieurs personnes. Celles-ci recevront un mail instantanément avec votre commentaire. C'est pratique quand vous souhaitez avoir une réponse rapide à votre question. + +## Effacer un commentaire ou une discussion +Cliquez simplement sur les troios petits points à droite de la discussion ou du commentaire en question : (...) et choisissez l'option "Effacer". +L'auteur.e d'un message peut toujours l'effacer. Un.e admin de groupe peux tout effacer. + +WARNING: Le fait d'effacer une discussion n'efface pas les fichiers joints à cette discussion. + ## Programmer des événements Chaque groupe dispose d'un calendrier dans lequel vous pouvez ajouter des actions/événements. Il vous suffit de définir une date et une heure de début, ainsi qu'une durée facultative. Si aucune durée n'est définie, elle est supposée être d'une heure. diff --git a/docs/fr/users_types.md b/docs/fr/users.md similarity index 100% rename from docs/fr/users_types.md rename to docs/fr/users.md diff --git a/mkdocs.yml b/mkdocs.yml index 9aaf483..6858d2b 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -76,6 +76,9 @@ nav: - First steps after install : first_steps.md - Creating & managing a group : group.md - Using Agorakit : usage.md + - Using tags : tags.md + - Users : users.md + - Deleting content : delete_content.md - 'Running Agorakit': - Installation : install.md - Advanced configurations : advanced_config.md