Sounds like great progress! Feel free to file a JIRA ticket and create a PR.

Regards,
Donald

On Mon, Jul 25, 2016 at 5:05 PM, Marcin Ziemiński <ziem...@gmail.com> wrote:

> I agree that the script should be rewritten in Ruby and I have already done
> that.
> In addition to that I have copied the entire old gallery to the yaml file
> and updated the docs with guidelines on how to submit new templates.
> Introduced changes
> <
> https://github.com/apache/incubator-predictionio/compare/develop...Ziemin:template-gallery
> >
>
> śr., 20.07.2016 o 16:56 użytkownik Pat Ferrel <p...@occamsmachete.com>
> napisał:
>
> > If we used the same mechanisms supported in the site generator it would
> > simplify support. Yaml is fine but isn’t middleman in ruby?Maybe you
> don’t
> > need a separate Python script.
> >
> > On Jul 20, 2016, at 9:50 AM, Donald Szeto <don...@apache.org> wrote:
> >
> > Hey Marcin,
> >
> > I think this looks great for now! I think it is fine to put
> templates.yaml
> > anywhere inside docs. We just have to update the instruction in the
> Engine
> > Template Submission section so that template contributors know where to
> > edit templates.yaml as a way of "submission".
> >
> > Any thoughts from the wider community is welcome.
> >
> > Regards,
> > Donald
> >
> > On Tue, Jul 19, 2016 at 4:48 PM, Marcin Ziemiński <ziem...@gmail.com>
> > wrote:
> >
> > > Hey Donald,
> > >
> > > I added the script to my local version of PredictionIO repository. It
> is
> > > being called from config.rb file during website build process.
> > > After some tweaking it looks like this:
> > > http://imgur.com/a/SDrl3
> > > The stars are visible now.
> > > I also put the templates.yaml file in the repo in the same directory. I
> > am
> > > quite not sure what would be the perfect place for it.
> > >
> > > wt., 19.07.2016 o 11:10 użytkownik Donald Szeto <don...@apache.org>
> > > napisał:
> > >
> > >> 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
> > >>>
> > >>
> > >
> >
> >
>

Reply via email to