> On 8 Jan 2015, at 06:39, Maruan Sahyoun <[email protected]> wrote: > > Hi > > Am 08.01.2015 um 13:18 schrieb Andreas Lehmkühler <[email protected] > <mailto:[email protected]>>: > >> >> >>> Maruan Sahyoun <[email protected]> hat am 8. Januar 2015 um 12:52 >>> geschrieben: >>> >>> >>> >>> Am 08.01.2015 um 12:39 schrieb Andreas Lehmkühler <[email protected]>: >>> >>>> >>>> >>>>> Maruan Sahyoun <[email protected]> hat am 8. Januar 2015 um 12:18 >>>>> geschrieben: >>>>> >>>>> >>>>> Am 08.01.2015 um 11:51 schrieb Maruan Sahyoun <[email protected]>: >>>>> >>>>>> Am 08.01.2015 um 11:44 schrieb Andreas Lehmkühler <[email protected]>: >>>>>> >>>>>>> Hi, >>>>>>> >>>>>>>> Maruan Sahyoun <[email protected]> hat am 1. Januar 2015 um 21:52 >>>>>>>> geschrieben: >>>>>>>> >>>>>>>> >>>>>>>> the docs shall reside in pdfbox-docs from where they will be pulled >>>>>>>> onto >>>>>>>> the >>>>>>>> website or looked at directly at github. >>>>>>>> >>>>>>>> The publishing process to our website is not yet in place as there is >>>>>>>> no >>>>>>>> new >>>>>>>> content. I'm looking to get the redesign of the website done to >>>>>>>> accommodate >>>>>>>> for the old 1.8 and new 2.0 release. >>>>>>> >>>>>>> The Apache Drill project seems to use something which could be >>>>>>> interesting >>>>>>> for >>>>>>> us as well, see the posting on dev@community >>>>>>> >>>>>>> http://markmail.org/message/vtb3or4tf7bb2hid >>>>>>> >>>>>> >>>>>> very nice idea >>>>> >>>>> I looked into that in more detail. This would replace the Apache CMS for >>>>> most >>>>> parts as this will be using jekyll to generate the html from the sources >>>>> which >>>>> means that all source files would be in there. >>>> This means that we have to move the whole site to github? Or could we start >>>> with >>>> a part of it, as planned for the docs? >>> >>> we can use that to only generate the docs. I can do a similar setup to see >>> how >>> that would work for us - would need to replicate some of the html template >>> so >>> it also works standalone. >>> >>> Shall I? >> It depends on the effort and the time you want to spend on that. We should >> try >> it if it is worth doing it. > > as jekyll is a replacement/similar to the Apache CMS testing it on the docs > is fine and we get some experience. > > pro: > - leverage GitHub to generate the docs > - use jekyll which is well documented > - full integration into GitHub to do automated builds
- How is this a pro? - What aspects of jekyll are we wanting to use that we haven’t been able to figure out with ApacheCMS? - ApacheCMS has automated builds to staging > cons: > - will need a local build to generate the HTML to push into SVN > [https://github.com/apache/drill/blob/gh-pages/README.md > <https://github.com/apache/drill/blob/gh-pages/README.md>] > - replicates the Apache CMS functionality That first point is a real headache, current my workflow for editing docs is: 1. edit a markdown file 2. commit to SVN 3. click publish on ApacheCMS site Anything which makes that harder isn’t good. The second point makes me think: if we’re stuck with some aspect of ApacheCMS, why not figure out how to use it? What are we stuck on? > At the end it's using jekyll and svnpubsub/manual upload or Apache CMS. Mixed > makes no sense for the long run or only if the Doumentation is a kind of > micro site similar to http://cordova.apache.org/docs/en/4.0.0/ > <http://cordova.apache.org/docs/en/4.0.0/> which is also a valid approach. > > Maruan > >> >> >>> >>>> >>>>> Other than that I do like the layout they have. >>>> I don't want to start a discussion about our layout ;-) but theirs is ok. >>>> >>> >>> Wasn't meant to be interpreted this way! >>> >>>> BR >>>> Andreas Lehmkühler >>>> >>>> P.S.: It looks like others are also interested in that solution, DeviceMap >>>> just >>>> asks for some pointers .... I'll continue tracing the thread >>>> >>>>>> >>>>>>> BR >>>>>>> Andreas Lehmkühler >>>>>>> >>>>>>>> >>>>>>>> Maruan >>>>>>>> >>>>>>>> Am 01.01.2015 um 19:38 schrieb John Hewson <[email protected]>: >>>>>>>> >>>>>>>>> Hi All, >>>>>>>>> >>>>>>>>> We’re getting closer to 2.0 being ready and I’m thinking about writing >>>>>>>>> some >>>>>>>>> docs, but currently the situation seems to be worse than it was before >>>>>>>>> the >>>>>>>>> docs stated moving to GitHub - where are our canonical docs and how >>>>>>>>> can >>>>>>>>> I >>>>>>>>> contribute to them? >>>>>>>>> >>>>>>>>> All I see on GitHub is some old 1.8 stuff and an incomplete cookbook >>>>>>>>> for >>>>>>>>> forms. Is this content live anywhere? Is there a pay to preview it? >>>>>>>>> >>>>>>>>> -- John
