Modification de la documentation #2451
Conversation
|
|
| │ └── ... | ||
| ├── member/ # module des membres | ||
| │ └── ... | ||
| ├── mp/ # module des MPs |
There was a problem hiding this comment.
Si on met un commentaire, autant être explicite et mettre "messages privés", non ? :)
|
Merci énormément pour cette PR ! :) |
| Le *front-end* | ||
| ============== | ||
|
|
||
| Le terme *front-end* désigne la partie du code associée à l'affichage des données issues du `back-end <back-end.html>`__. Il s'agit donc de la partie du code ayant attrait au design et à l'affichage, écrite en HTML (en employant le `langage de template de Django <https://docs.djangoproject.com/en/dev/topics/templates/>`__), à l'aide de SASS pour les feuilles de style et de Javascript (au travers de Node.js). |
There was a problem hiding this comment.
ça serait peut être intéressant de rappeler que le frontend s'occupe aussi de l'ergonomie, de la réactivité et de l'expérience utilisateur.
There was a problem hiding this comment.
Il s'agit donc de la partie du code ayant attrait au design et à l'affichage, écrite en HTML (en employant le
langage de template de Django <https://docs.djangoproject.com/en/dev/topics/templates/>__), à l'aide de SASS pour les feuilles de style et de Javascript (au travers de Node.js).
La phrase est complexe je trouve. On peut pas la tourner comme ça :
Il s'agit donc de la partie du code définissant le design et l'affichage. Sa mise en place est basée sur trois langages :
Le HTML aidé du
langage de template de Django <https://docs.djangoproject.com/en/dev/topics/templates/>__)SASS pour les feuilles de style
Javascript pour les intéraction.
NodeJS, son gestionnaire de packet (npm) et Gulp sont utilisés pour générer le code finale minifié et cohérent.
|
Globalement c'est tout bon. j'ai fait deux petites suggestions mais rien de bien grave. |
|
Ok, j'ai tenu compte de vos remarques ;) |
|
|
|
@Situphen : fait :) |
|
Pour information, parce que c'est pas super lisible sur le diff, j'ai déployé cette branche à l'adresse suivante : http://vps137741.ovh.net:2451/ Le lien de consultation de la doc est celui-ci : http://vps137741.ovh.net:2451/doc/ |
|
Ca charge ca charge... Marche pas j'ai l'impression... (le port est le même que la PR, serait-ce la mise en oeuvre de ce a quoi que je pense ? :) ) |
Toi, t'as gagné une boite de chocolat ... Ou presque. Je viens de changer la branche au moment ou t'as eu l'idée ;) |
|
@Eskimon : http://vps137741.ovh.net:2451/doc/ ? Ça marche nickel chez moi |
|
Idem, ça marche chez moi aussi. |
|
Bon... je vais ressayer a domicile on verra bien |
|
Chut, coveralls, cette PR ne peut pas faire chuter la couverture à ce point !! |
|
|
Mauvaise langue, il est passé à 79% :-° |
| Fichiers principaux | ||
| ------------------- | ||
|
|
||
| Django étant basé sur une architecture de type Modèle-Vue-Controleur, on retrouve les modèles dans le fichier ``models.py`` et les vues associées à celles-ci dans ``views.py``. Ces dernières peuvent employer des classes formulaires qui sont définis dans ``forms.py``. Les URLs associées au module et permetant d'accéder aux vues sont définies dans ``urls.py``. On retrouve finalement des vues spécifiques associées aux fils RSS et Atom dans ``feeds.py``. |
There was a problem hiding this comment.
une architecture de type Modèle-Vue-Controleur
Avec Django c'est plutot "Modèle Vue Template"
There was a problem hiding this comment.
Je suis d'accord avec toi, mais j'associerai les templates aux Vues (le contrôleur, c'est Django)
|
Yep ca marche a la maison... Et je viens d’innocemment tester une autre PR en changeant le port... @firm1 est un BG !! |
Attention, ça ne fonctionne pas encore à 100% mon serveur étant relativement petit, je ne peux pas deployer plus de 2 PRs pour le moment |
|
@firm1 Tu pourras nous fournir le script et le dimensionnement de ton serveur pour le jour où on parlera sérieusement de faire tourner tout ça sur des serveurs de l'association ? |
|
No problem, le script est déjà opensource mais ce n'est pas encore le moment du l'utiliser. |
| ├── middlewares/ # codes provenant de sources externes | ||
| │ └── ... | ||
|
|
||
| On retrouve également dans ce dossier les quelques fichiers suivants, nécéssaires à la configuration et au fonctionnement de Django : |
There was a problem hiding this comment.
"nécessaires" et pas "nécéssaires" (présent ailleurs dans la documentation)
|
j'ai fait une pr sur le dépôt de @pierre-24 pour corriger l'orthographe pierre-24#1 |
|
Merci @artragis, je merge ça de suite :) |
|
Voilà :-) |
|
to be merged, @Eskimon ? (ah ah, tu peux pas répondre "pong" cette fois ci!) |
Modification de la documentation
|
C'est un petit pas pour ZdS, mais un grand bond pour sa documentation ! |
|
et la doc de la zep 12 peut commencer ^^ |
|
Et énorme merci à @pierre-24 de s'être tapé tout ça. C'est du bon boulot |
|
... L'aventure est pas tout à fait terminée :'( On dirait que RTD a une erreur d'encodage ? :o |
|
étrange... chez moi ça marche. |
|
Chez moi aussi, bien entendu. |
|
(et je viens de checker, j'ai pas mis un fichier en ISO-8859-1 pour faire mon troll, c'est UTF-8 partout. Par contre, il bloque sur la partie "critique", à savoir la documentation de code) |
Ça, là, c'est la PR pour laquelle tout le monde va me détester, qui va prendre un mois à ce faire QA et qui va générer une tonne de discutions, de rebases et ainsi de suite ;)
But
contributing.mdetworkflow.rstsont bien comme ils sont.Note de QA
Se placer dans le dossier de documentation et régénérer celle-ci (nécessite SPHINX, qui est installé comme dépendance du back):
cd doc/ make clean make htmlVérifier (et j'insiste, parce que je suis spécialiste) que tout est cohérent et qu'il n'y a pas de fautes d'orthographe. Ne pas hésiter à me faire part de vos suggestions.