help/content/files/_index.md

2.3 KiB

date title weight
2019-04-04T15:59:52+02:00 Arborescence et fichiers 10

Afin de pouvoir être importé automatiquement sur la plate-forme, vos scénarios doivent respecter une certaine arborescence que voici :

    .
    ├── AUTHORS.txt
    ├── overview.md
    ├── title.txt
    ├── heading.jpg
    ├── repochecker-ack.txt
    ├── CHID-Titre de l'étape/
    │   ├── challenge.txt
    │   ├── finished.md    (opt.)
    │   ├── heading.jpg    (opt.)
    │   ├── links.txt
    │   ├── overview.md
    │   ├── resolution.md   (choice)
    │   ├── resolution.mp4  (choice)
    │   ├── statement.md
    │   ├── files/
    │   │   ├── DIGESTS.txt
    │   │   └── ...
    │   └── ressources/
    │       └── ...
    │
    ├── CHID-Titre de l'étape/
    │   └── ...
    └── ...

{{% notice warning %}} Pour le bon usage et la bonne configuration de vos dépôts sur GitLab, veuillez consulter [la page dédiée]({{<relref "git">}}). {{% /notice %}}

{{% notice info %}} N'ajoutez pas inutilement de dossiers ou fichiers vides. Ceux-ci doivent sans doute être optionnels et risquent de vous/nous induire en erreur lors de nos vérifications. {{% /notice %}}

Utilisez le binaire repochecker (amd64/linux) pour vous assurer de votre arbrescence et de la validité du contenu des fichiers :

cd /mnt/fic/MyTheme
repochecker .
...
repochecker /mnt/fic/MyTheme/1-MyChallenge/

CHID

Dans les noms de dossiers, CHID correspond à un identifiant permettant de référencer votre étape (pour déclarer une dépendance sur celle-ci par exemple).

L'import s'effectuant selon l'ordre alphabétique, vous devriez utiliser le numéro d'ordre de l'étape comme identifiant :

    .
    ├── 1-Titre du premier défi/
    │   └── ...
    ├── 2-Titre du deuxième défi/
    │   └── ...
    └── ...

Dans cet exemple, si l'ordre était déterminé uniquement par l'ordre alphabétique des noms de dossiers, le deuxième serait devant le premier (d<p). Ajouter le numéro d'ordre permet de contrôler plus facilement l'ordre des étapes, sans que cela soit affiché dans l'interface.