diff --git a/docs/_static/img/choose_tournament.png b/docs/_static/img/choose_tournament.png new file mode 100644 index 0000000..d12f094 Binary files /dev/null and b/docs/_static/img/choose_tournament.png differ diff --git a/docs/_static/img/create_team.png b/docs/_static/img/create_team.png new file mode 100644 index 0000000..729de1a Binary files /dev/null and b/docs/_static/img/create_team.png differ diff --git a/docs/_static/img/join_team.png b/docs/_static/img/join_team.png new file mode 100644 index 0000000..c71bc79 Binary files /dev/null and b/docs/_static/img/join_team.png differ diff --git a/docs/_static/img/team_info.png b/docs/_static/img/team_info.png new file mode 100644 index 0000000..51757ce Binary files /dev/null and b/docs/_static/img/team_info.png differ diff --git a/docs/_static/img/tournament_info.png b/docs/_static/img/tournament_info.png new file mode 100644 index 0000000..8e8e75d Binary files /dev/null and b/docs/_static/img/tournament_info.png differ diff --git a/docs/_static/img/user_info.png b/docs/_static/img/user_info.png new file mode 100644 index 0000000..bc54cae Binary files /dev/null and b/docs/_static/img/user_info.png differ diff --git a/docs/_static/img/validate_team.png b/docs/_static/img/validate_team.png new file mode 100644 index 0000000..dd0dc76 Binary files /dev/null and b/docs/_static/img/validate_team.png differ diff --git a/docs/admin/index.rst b/docs/admin/index.rst new file mode 100644 index 0000000..c363302 --- /dev/null +++ b/docs/admin/index.rst @@ -0,0 +1,2 @@ +Administrer la plateforme +========================= diff --git a/docs/conf.py b/docs/conf.py index 128ec7f..4b9748c 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -18,7 +18,7 @@ # -- Project information ----------------------------------------------------- project = 'Plateforme du TFJM²' -copyright = "2020-2021" +copyright = "2020-2023" author = "Animath" diff --git a/docs/index.rst b/docs/index.rst index 215e312..4a181ad 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,23 +1,20 @@ Documentation de la plateforme du TFJM² ======================================= -.. image:: https://gitlab.com/animath/si/plateforme-tfjm/badges/master/pipeline.svg - :target: https://gitlab.com/animath/si/plateforme-tfjm/-/commits/master - :alt: Pipeline status +Ce site vise à documenter l'usage de la plateforme de gestion du TFJM², aussi +bien du côté utilisateur⋅rice que du côté organisateur⋅rice ou bien +administrateur⋅rice. -.. image:: https://gitlab.com/animath/si/plateforme-tfjm/badges/master/coverage.svg - :target: https://gitlab.com/animath/si/plateforme-tfjm/-/commits/master - :alt: Coverage report -.. image:: https://img.shields.io/badge/License-GPL%20v3-blue.svg - :target: https://www.gnu.org/licenses/gpl-3.0.txt - :alt: License: GPL v3 +.. toctree:: + :maxdepth: 3 + :caption: Utiliser + + user/index .. toctree:: :maxdepth: 3 :caption: Développer -.. toctree:: - :maxdepth: 3 - :caption: Jouer + admin/index diff --git a/docs/user/index.rst b/docs/user/index.rst new file mode 100644 index 0000000..11f68ee --- /dev/null +++ b/docs/user/index.rst @@ -0,0 +1,222 @@ +Utiliser la plateforme +====================== + +.. contents:: + +Cette plateforme est conçue pour que les différentes équipes puissent s'inscrire au TFJM² et envoyer +leurs solutions. + +Si vous êtes ici, c'est que vous avez des questions sur l'utilisation du site en tant que participant⋅e. + +Les inscriptions ouvrent dans le courant du mois de janvier, généralement une semaine après la publication +des problèmes. Pour l'édition 2023, les inscriptions ouvrent le 11 janvier 2023. + +Tout se passe sur le site https://inscription.tfjm.org/. + + +S'inscrire +---------- + +Il est important de noter que chaque personne d'une équipe doit s'inscrire, y compris les encadrant⋅es. + +Rendez-vous sur le site d'inscription, bouton « S'inscrire » en haut à droite. + +Les informations suivantes sont requises pour tout le monde : + +* Prénom d'usage +* Nom de famille (ou d'usage) +* Adresse électronique (sera vérifiée) +* Mot de passe et confirmation +* Rôle (participant⋅e ou encadrant⋅e) +* Date de naissance +* Genre +* Adresse postale +* Numéro de téléphone de contact +* Problèmes de santé à déclarer +* Donne son consentement pour se faire recontacter par Animath + +Informations demandées exclusivement aux élèves : + +* Classe (seconde ou avant/première/terminale) +* Établissement scolaire +* Nom du responsable légal +* Numéro de téléphone du responsable légal +* Adresse e-mail du responsable légal + +Informations exclusivement demandées aux encadrant⋅es : + +* Activité professionnelle + +Une fois inscrit⋅e, vous recevrez par mail un lien de confirmation, qu'il vous faudra cliquer. + + +Connexion +--------- + +Une fois inscrit⋅e, vous pouvez vous connecter en utilisant le bouton en haut à droite. + +Dans le champ « nom d'utilisateur », rentrez votre adresse mail. Si vous avez oublié votre mot de +passe, un formulaire est disponible pour vous aider à le réinitialiser. Vous pouvez ensuite vous +connecter. Votre prénom et votre nom apparaîtra en haut à droite. + + +Créer une équipe +---------------- + +Il suffit d'une seule personne (participant⋅e ou encadrant⋅e) pour créer une équipe. Pour créer une +équipe, il faut cliquer sur le bouton « créer une équipe ». Un nom d'équipe et un trigramme seront +demandés. Le trigramme est composé de 3 lettres majuscules, c'est ce qui permettra aux +organisateur⋅rices d'identifier rapidement votre équipe. + +.. image:: /_static/img/create_team.png + :alt: Création d'une équipe + +Une fois l'équipe créée, vous obtenez un code à 6 caractères, lettres ou chiffre. Ce code est à +transettre à l'ensemble des membres de votre équipe (et seulement à elleux). + +.. image:: /_static/img/team_info.png + :alt: Information sur l'équipe nouvellement créée + + +Rejoindre une équipe +-------------------- + +Si l'équipe est déjà créée, vous aurez besoin du code d'accès transmis par la personne ayant créé +l'équipe. Vous pouvez cliquer sur « Rejoindre une équipe », et entrer le code. + +.. image:: /_static/img/join_team.png + :alt: Rejoindre une équipe par son code d'accès + +Vous avez désormais normalement rejoint l'équipe. + +En cas de problème, ou si vous ne savez pas de quel code on parle, contactez-nous à l'adresse +contact@tfjm.org. + + +Informations sur les tournois +----------------------------- + +Les tournois peuvent être trouvés dans l'onglet « Tournois ». Vous avez accès, pour chaque tournoi, +à l'ensemble des dates importantes et les lieux des tournois. + +.. image:: /_static/img/tournament_info.png + :alt: Informations sur un tournoi + +Davantage d'informations peuvent être trouvées sur le site vitrine : https://tfjm.org/infos-tournois/. + + +Choisir un tournoi +------------------ + +Pour accéder aux paramètres de votre équipe, vous pouvez aller sur l'onglet « Mon équipe », dans la +barre de navigation. + +Pour choisir votre tournoi, il vous suffit de vous rendre sur la page de votre équipe et de cliquer +sur « Modifier ». Un formulaire vous permet alors de choisir votre tournoi. + +.. image:: /_static/img/choose_tournament.png + :alt: Formulaire de mise à jour de l'équipe permettant de choisir un tournoi + +Attention cependant : cela ne confirme pas votre inscription. Vous devez pour cela envoyer l'ensemble +de vos documents (voir ci-dessous). + + +Transmettre ses documents +------------------------- + +Pour valider votre inscription, vous devez : + +* Avoir choisi un tournoi ; +* Que chaque membre de l'équipe ait transmis : + + * Autorisation de droit à l'image ; + * Fiche sanitaire de liaison et carnet de vaccination (pour les mineur⋅es) ; + * Autorisation parentale (pour les mineur⋅es) ; + +* Transmettre une lettre de motivation. + +La lettre de motivation doit être envoyée une seule fois pour toute l'équipe, peut être envoyée +depuis l'interface « Mon équipe », au format PDF, dont le contenu est défini dans l'article 5.3 +du guide de læ participant⋅e : https://tfjm.org/reglement/. + +Concernant les documents personnels, ils peuvent être envoyés depuis le menu « Mon compte », qui +peut être trouvé en haut à droite dans la barre de navigation. Chaque fichier doit être envoyé +au format PDF et peser moins de 2 Mo. + +.. image:: /_static/img/user_info.png + :alt: Informations sur l'utilisateur⋅rice + +En cas de besoin, contactez-nous à l'adresse contact@tfjm.org. + + +Valider son équipe +------------------ + +Pour prétendre à la validation, il faut que l'équipe compte au moins 1 encadrant⋅e et 4 participant⋅es. +Il faut ensuite que la lettre de motivation soit transmise, le tournoi choisi et que tous les documents +nécessaires ont été transmis (voir section précédente). + +Une fois tous les prérequis réunis, sur la page « Mon équipe », il est possible de cliquer sur le bouton +pour demander la validation. + +.. image:: /_static/img/validate_team.png + :alt: Formulaire de validation d'équipe + +.. warning:: + Les places étant limitées, rien ne garantit que vous pourrez avoir votre place dans le tournoi. Nous + vous encourageons à respecter un maximum les critères définis dans le règlement : + https://tfjm.org/reglement/. Selon les disponiblités et votre position géographique, il pourra + vous être proposé de participer à un tournoi voisin. + + Une fois les deadlines dépassées, rien ne vous garantit une place au TFJM², alors attention aux dates. + +Vous recevrez par mail une réponse des organisateur⋅rices locaux⋅ales. En cas de besoin, contactez-nous +à l'adresse contact@tfjm.org. + + +Payer son inscription +--------------------- + +Une fois votre inscription validée, il vous faudra payer votre inscription. Les frais s'élèvent à +23 € par élève, sauf pour les élèves boursièr⋅es qui en sont exonéré⋅es. Les encadrant⋅es n'ont pas +à payer. + +.. note:: + Ces frais couvrent une partie des frais de restauration et d'hébergement. L'organisation reste + bénévole. + +.. TODO +.. note:: + Cette section sera mise à jour plus tard. + + +Envoyer ses solutions +--------------------- + +.. TODO +.. note:: + Cette section sera mise à jour plus tard. + + +Participer au tirage au sort +---------------------------- + +.. TODO +.. note:: + Cette section sera mise à jour plus tard. + + +Envoyer ses notes de synthèse +----------------------------- + +.. TODO +.. note:: + Cette section sera mise à jour plus tard. + + +Récupérer les solutions adverses +-------------------------------- + +.. TODO +.. note:: + Cette section sera mise à jour plus tard.