Hi Marcin, This is a great draft! Since this is generating a Markdown file, one suggestion I could think of is to make this an integral part of the current documentation build. Would you like to take a look at it and see how feasible this could be?
We used to have a Git branch called "livedoc" which branch off from "master" on each release. Immediate documentation contributions and changes go to the "livedoc" branch and get rebuilt and deployed immediately by Travis. We can do something similar again. Regards, Donald On Mon, Jul 18, 2016 at 5:59 PM, Marcin Ziemiński <ziem...@gmail.com> wrote: > Hi! > > As mentioned in the other thread, there is a need for a new > community-driven template gallery. > I am proposing basic and simple approach based on github repository > developed through pull requests. You can find the first draft here: > https://github.com/Ziemin/pio-engine-templates > > - The central part of this repo is the *templates.yaml *file*, *where > new engines are introduced in a unified way*. *At this moment I tried to > keep the schema possibly similar to the old template gallery. > - README.md grouping and listing engines is not modifiable, as it is > generated by the python script - *generate_md.py*. Every update to the > yaml config should entail rerun of the script. > > Keeping a separate yaml file with all the information related to engines > has both positive and negative sides. Obviously the most visible drawback > is the requirement of re-runing the script manually. On the other hand, it > helps keep the entries in a consistent manner. What is more, future changes > to the esthetics of README.md file will rely exclusively on the script. We > can also imagine a situation, when someone would create a separate website > having some more user friendly capabilities like searching and filtering > templates, which would link to the yaml file in the central repository. > > I tried to add the buttons with github stars for every template, but it > appears that github ignores necessary html tags (iframe). > > I am aware that neither schema nor README.md is perfect. This repo is a > draft and definitely could use some comments. > > Regards, > > Marcin >
