⚠️ attention : ce document est en cours de rédaction.
L'idée principale de cet outil repose sur deux types d'objets : les publications et les projets.
Une publication peut être un article de blog, un tutoriel, ou toute autre forme de document court détaillant un sujet simple.
Un projet est un espace de collaboration permettant à ses contributeurs de collecter, de créer ou d'organiser des publications afin d'obtenir une documentation claire et organisée du projet.
Cette structure modulaire permet de lier à plusieurs projets une même publication afin de mutualiser la rédaction de documentation de projets.
Par exemple, un tutoriel détaillant l'utilisation d'une machine à découpe laser pourra apparaître sur la documentation d'un projet de robot ou sur la documentation d'un projet de fabrication de décorations de Noël.
Lorsqu'un utilisateur crée un nouvel object Publication, il en devient automatiquement l'auteur (champ Publication.owner de type ForeignKey vers un objet CustomUser).
Ce dernier doit être le seul à avoir des droits d'édition sur sa publication, à l'exception de l'attribut Publication.visibility que peut éditer un modérateur pour rendre publique ou non la publication après relecture.
Le champ Publication.type (de type ForeignKey vers un objet PublicationType) permet d'attribuer à une nouvelle publication l'un des types prédéfinis sur le site (par exemple un article de blog, un tutoriel de fabrication, une fiche pédagogique, etc.).
Ce champ, défini à la création de l'objet, ne doit pas pouvoir être changé par la suite.
L'objet Publication comporte, entres autres, le champ Publication.body (de type JSONField) qui permet de structurer le contenu de la publication au format JSON afin d'apporter une certaine souplesse en terme de présentation. Ainsi, un tutoriel sera en général constitué d'une série d'étapes numérotées constituées chacune d'une ou plusieurs images et d'un paragraphe de texte rédigé en language markdown. Quant à un article de blog, son contenu sera plutôt constitué d'une succession linéaire de paragraphes, d'images ou de liens.
Un projet est un espace permettant la collaboration de plusieurs utilisateurs autour d'un même sujet.
Plusieurs collaborateurs (champ Project.contributors de type ManyToManyField vers des objets CustomUser, via la classe ProjectContributor) peuvent participer à un projet.
Un contributeur possède l'un des rôles suivants (via l'attribut ProjectContributor.role) :
OWNER: a tous les droits sur le projet, notamment sur la gestions des contributeurs ;EDITOR: possède quelques droits d'édition (ajouter de nouvelles publications, des entrées de la forge, etc.).CONTRIBUTOR: une simple mention dans la liste des contributeurs, sans droit particulier.
Le créateur d'un projet se voit attribuer automatiquement le rôle OWNER.
Un projet dispose d'une forge dans laquelle les contributeurs peuvent poster des images, du textes, des liens, etc. en prévision de la rédaction des publications.
Un projet dispose d'un espace issues permettant aux contributeurs de remonter les problèmes rencontrés lors de la réalisation du projet. Ces problèmes pourront être, si besoin, affichés sur la page d’accueil du site pour faire appel à de nouveaux contributeurs.
Un projet dispose d'un espace de discussion public, le forum, pour faciliter les échanges entres les contributeurs d'un projet et le reste du monde !
Le cahier de laboratoire, ou labbook est un espace personnel, non public, permettant de prendre des notes au fil de l'eau (fonctions équivalentes à la forge d'un projet). Il peut s'agir de photos, liens, notes, etc.
Ces notes pourront ensuite être réutilisées lors de la rédaction de publications.
Chaque utilisateur a la possibilité de rendre public tout ou partie de son profil comme la liste des projets auxquels il participe, ses publications, ses contributions, etc. Son profil sera alors visible dans le trombinoscope du site.
Une instance de myworkshop peut être internationalisée, à la fois pour le contenu statique et pour le contenu dynamique. La liste des langues disponibles est définie dans settings.
Certains champs des publications et projets peuvent alors être traduit. À défaut de traduction disponible dans une langue spécifique, le contenu est affiché dans la langue principale du site.
myworkshop utilise le paquet django-modeltranslation pour fournir des champs multilingues aux modèles.
Le paquet django-simple-history est utilisé dès le départ. Même si l'implémentation est développée plus tard, l'historique aura été sauvegardé.
Il est prévu de développer une API web RESt à l'aide du paquet django-rest-framework afin de mettre en place un réseau peer to peer de partage de publications entres plusieurs instances de myworkshop.
Une attention particulière est portée à l'accessibilité du site web afin de permettre aux utilisateurs malvoyant d'utiliser leurs outils d'accessibilité ou aux utilisateurs de mobile d'avoir un accès facile à l'ensemble des fonctions du site.
L'authentification des utilisateurs repose principalement sur le paquet django-allauth, dont les templates sont surchargées dans l'application apps/accounts.