La documentation est désormais éditable par tous!

News
#1

Salut à tous,

Petite avancée de cette après midi, il est désormais possible d’éditer la documentation sur Github ( ici : github.com/GladysProject/gladys-docs ), et de proposer une pull request.

Ainsi dès que mergerais la pull request, vos modifications apparaitrons automatiquement ( sans actions de ma part ) sur le site développeur ( ici : developer.gladysproject.com/fr/documentation )

En fait j’ai juste ajouté activé les webhooks GitHub sur le repository, quand une modification est faite sur le repository, automatiquement github envoit une requête POST sur mon site ( sur une URL spécifique ) et prévient ainsi mon site qu’il doit se resynchro avec GitHub. Le site se resynchro et hop les modifications apparaissent ! :slight_smile:

N’hésitez pas à faire des modifications dans la doc, maintenant les changement seront apparent! :wink:

#2

Cool

Y’a moyen de faire des sous catégories ?

#3

Pourquoi pas oui :slight_smile: Tu verrais ça pour quelle genre d’utilisation ?

#4

J’aurai bien détaillé l’installation manuelle vu que pour certains les instructions sur le dépôt ne sont pas suffisantes.

A voir :wink:

#5

Pourquoi pas oui, pas bête! :slight_smile:

Après on peut juste jouer sur le titre de la page pour faire des sous catégorie :

#6

( D’ailleurs pour préciser les titres c’est moi qui les fixe, le nom du fichier sur le github ne détermine pas le nom de la partie )

#7

J’allais poser la question :slight_smile:

J’ai forker et commencer à détailler l’installation windows / L’install par npm ne passe bien mais gladys ne démarre pas, j’essaye de comprendre pourquoi.

Je met le lien un peu à l’arrache mais pas de bbcode désolé:
github.com/VonOx/gladys-docs/bl … windows.md

#8

Super propre!

Je vais essayer de faire le même sous Mac/Linux.

Par contre je pense tu pourrais même être un poil plus précis quand tu dis “Ajoutez la variable d’environnement GYP_MSVS_VERSION et définir sa valeur à 2013”, en donnant carrément les manipulations à faire, on risque d’avoir des questions sinon de débutants. Plus c’est clair et moins on a de “support” à faire derrière !

#9

Oui tu as raison je vais détailler cette partie

J’aurais bien mis quelques screenshot, on les verra sur le site si je les ajoute au dépôt ?

#10

Non ça ne marchera pas !

Je réfléchis à un moyen de faire ça proprement… De toute manière il faudra que je les upload sur le serveur du site gladys, mais est ce que je fais au cas par cas ( de type tu m’envoie par mail les images et je te donnerais les URL des images ) , ou est-ce qu’on dit que sur le repo on mets un dossier “assets” ou on mettrais toutes les images, et moi après – automatique ou manuellement – j’importerais ces images sur le serveur…

En fait j’ai peur que le repo soit lourd avec les images et qu’au final il soit lent à cloner et que ça freine les gens à contribuer. T’en pense quoi ?

#11

Ouai ça va être lourd.

Je te les enverrai par mail et tu me filera les url

Merci :wink:

#12

Par contre pour les images essaient d’être léger, type taille < 80ko ( enfin dépend de la taille de ton image, mais faut que ça dépasse rarement 100ko )

#13

Bon j’ai presque fini ( pas encore push ).

Une question me taraude, publie -t- on la doc même si ça marche pas ?

#14

C’est à dire ‘si ça ne marche pas’ ?