Documentation

Vous avez un machin et vous cherchez où ça se range ? Vous trouverez votre réponse ici ! :)

Se connecter en SSH ou SFTP à files.mde.utc. Plus d'infos sur le wiki des assos, ici pour le FTP, là pour le SSH. Les identifiants se trouvent dans le fichier de mots de passe de la Dropbox Bureau.

De manière générale, ce qui constitue les archives. C'est le seul endroit où un repreneur de l'asso peut avoir accès sans problème. On peut également y stocker des fichier sans trop de soucis de place.

Entre autres :

• le mot de passe de la Dropbox principale (qui contient elle tous les autres mot de passe)
• de vieux albums photo ou fichier d’administration qui n'ont plus lieu de se trouver dans la Dropbox.

Il est destiné à être le lieu de communication de l'asso. Le dernier post est automatiquement copié sur la page d'accueil du site et on peut partager un post sur Facebook (#c'estBeauLaTechnologie).

L'interface d'administration se trouve sur /admin. Les identifiants sont dans le fichier de mots de passe dans la Dropbox.

• la communication de l'asso, les avancements, le déroulement des matchs
• les photos

Pour la capitalisation des connaissances ! Mais non, ça n'est pas chiant, ton prochain te remerciera ;)

Je te laisse deviner ;)

• Fonctionnement global du robot de l'année (avec de jolis dessins)
• Explications génériques des appareils/capteurs/actionneurs/logiciels utilisés (non spécifique à l'année en cours).

La présentation de l'asso

Ici pour le voir, les modifications se font sur le dépôt Github dédié.

• La présentation de l'asso
• La présentation du robot et de la solution de l'année
• Le dernier billet de blog (pas besoin de s'inquiéter, c'est comme les antibiotiques)
• Les partenaires (pensez à bien mettre ça à jours !)
• Quelques photos récentes

La documentation du code spécifique de l'année

Dans le code du dépôt Github de l'année : https://github.com/utcoupe/coupeXX. Dans le dossier /doc s'il existe.

• Les commentaires du code (une absolue obligation, des gens sont allés en prison pour moins que ça), éventuellement dans un format spécifique (Doxygen par exemple), obligatoirement en ANGLAIS.
• Les explications spécifiques aux classes, méthodes et attributs ainsi que leur relations, obligatoirement en ANGLAIS.

Attention ! Toute explication du fonctionnement général du code, d'un module ou d'un algo doit se trouver sur le wiki (avec éventuellement un lien dans le code si besoin).

Les fichiers privés de l'asso, accessible par le bureau.

Il faut demander à ce qu'un ancien vous le partage. Si vous venez de reprendre l'asso sans contact avec un membre de l'ancien bureau, connectez-vous au Z, le mot de passe du compte UTCoupe sur Dropbox doit s'y trouver.

• fichiers administratif
• mots de passe

Les fichiers CAO, accessibles par tout le monde.

Il faut demander à ce qu'un autre membre vous le partage.

• fichiers de pièces et d’assemblages