Votre documentation d'extension, vous le gérez comment ?

[cavo789]

Re : Votre documentation d'extension, vous le gérez comment ?

Salut Manu

Pour simplifier la compréhension de ton composant, peut-être expliquer comment l'installer. Je crois comprendre qu'il suffit de le copier sur son site puis de faire un Découvrir... mais pas sûr.

[elecoest]

Re : Votre documentation d'extension, vous le gérez comment ?

Hola !! C'est plus compliqué que çà

Pour le moment :
- tu télécharges le composant
- tu le compresses
- tu l'installes comme tout composant
- tu définis toutes les entrées que tu souhaites **Manuellement**
- tu cliques sur MakeMD et çà génère ta documentation

Par contre j'aime bien ton "découvrir"

[cavo789]

Re : Votre documentation d'extension, vous le gérez comment ?

Github permet de télécharger immédiatement un zip, cela ne permet pas de remplacer tes trois points ci-dessus ?

[elecoest]

Re : Votre documentation d'extension, vous le gérez comment ?

si bien sur

[elecoest]

Re : Votre documentation d'extension, vous le gérez comment ?

c'est en ligne

tu télécharges le ZIP tu l'installes
tu vas dans l'écran extensions et tu cliques sur "Discover" magique

Bien sur il reste beaucoup de choses à faire.

Manu

[cavo789]

Re : Votre documentation d'extension, vous le gérez comment ?

It's magic ;-)

Installation réussie et après quelques instants pour piger le truc (pourquoi ne crées-tu pas toi-même les dossiers?), oui, j'ai pu générer un fichier .md après avoir sélectionné un module (aeSecure Quick Icons). Toutefois, le contenu généré est strictement en lien avec AE mais c'est hyper prometteur !

Cool (y)

[elecoest]

Re : Votre documentation d'extension, vous le gérez comment ?

Pour la création de dossiers j'y ai pensé oui t'as qu'a faire une issue ;-)

Pour le moment le template est en dur donc oui il ressemble à du AllEvents

Oui c'est prometteur et avec l'aide de développeurs çà peut faire une documentation vraiment pas mal

[liubov]

Re : Votre documentation d'extension, vous le gérez comment ?

Extra Manu!

Je suis en train de tester sur ma plateforme.
J'ai pu installer ton composant directement via l'installer (super!).
Peux tu remettre une image de la configuration d'une Extension (image précédente indispo).

[elecoest]

Re : Votre documentation d'extension, vous le gérez comment ?

en fait il te suffit de cliquer sur Discover
ca va te récupérer toutes tes entrées utiles et les intégrer
tu publies l'extension que tu souhaites documenter
tu crée une catégorie pour affecter ta ligne (c'est plus cool) sinon tout sera sur catégorie ROOT
tu cliques sur Make MD et c'est joué

attention : il faut que tous les repertoire dans marknotes soient créés

[liubov]

Re : Votre documentation d'extension, vous le gérez comment ?

attention : il faut que tous les repertoire dans marknotes soient créés

Ok, tout ce qui est au dessus est acquis, impec !

Par contre, "tous les rep dans marknotes", c'est quoi? juste ça ?

> $HOME/documentation/docs/MYCATEGORY
> $HOME/documentation/docs/MYCATEGORY/views
> $HOME/documentation/docs/MYCATEGORY/plugins
> $HOME/documentation/docs/MYCATEGORY/modules
> $HOME/documentation/docs/MYCATEGORY/items

[liubov]

Re : Votre documentation d'extension, vous le gérez comment ?

Ok, vu !

Premier fichier .md généré pour mon composant WHAOO, y'a du monde !
Je l'envoie dans la moulinette MD de Cavo

[elecoest]

Re : Votre documentation d'extension, vous le gérez comment ?

sinon tu as des viewer de fichier MD en ligne

[garstud]

Re : Votre documentation d'extension, vous le gérez comment ?

sinon tu as des viewer de fichier MD en ligne

Je viens de l'installer et de le tester...
Bravo ! très bon début !
- le Discover est super
- il manque juste un msg quand tu lances un Make MD et que tu n'as aucune extension de publiée (oups ! j'ai pas compris tout de suite qu'il fallait les publier)

Pour lire du MarkDown, j'utilise l'extension "MarkDown Reader" pour Chrome :

https://chrome.google.com/webstore/detail/markdown-reader/gpoigdifkoadgajcincpilkjmejcaanc

(y a juste a drag 'n drop le fichier.md dans le navigateur et il le transcode direct !)
Ca existe aussi pour Firefox !

[garstud]

Re : Votre documentation d'extension, vous le gérez comment ?

Emmanuel, je t'ai collé 3 issues dans Github (au cas ou tu t'ennuis ) :

https://github.com/elecoest/AE2MD/issues

J'essaye de proposer des PR correctifs (Pull Resquest) ce WE si je trouve un peu de temps !

Le projet est sur Github ("Le Facebook des devs" ), donc les dev, viendez aider Emmanuel en notant vos remarques dans des Issues et proposer des patchs correctifs dans des PR Merci pour lui !

[liubov]

Re : Votre documentation d'extension, vous le gérez comment ?

+1,
demande d'ajout du xml Update Server afin que Joomla nous alerte des MAJs de cette superbe Extension en plein évolution

Je galère pour la génération du .md relatif aux .xml de définition des Fields de données. (8 tables -> 8 .xml)
/admin/models/forms/*.xml dans le cas de mon composant.

@ manu, ton composant peut il les lire/voir ???