Alexey, yes, cherry-pick to branches and update website for each version as well (this can be automated with a script) Still a bit cumbersome, but at least you don't have to make the same edit multiple times.
On Fri, Feb 2, 2018 at 10:59 AM, Alexey Kuznetsov <akuznet...@apache.org> wrote: > Pavel, > > Do I correctly understand, that if I find a typo in docs, I should commit > fix to master and cherry-pick to all relevant branches? > > On Fri, Feb 2, 2018 at 2:28 PM, Pavel Tupitsyn <ptupit...@apache.org> > wrote: > > > I did some research for my blog some time ago, and proposal is: > > > > * Export markdown from Readme.io (tweak as necessary, code samples etc) > > * Store markdown in git. Separate branch for each Ignite version > > (ignite-2.3-docs, ignite-2.4-docs, etc). Future version is in master. > > * Use Jekyll to generate HTML from markdown > > * Host documentation on ignite.apache.org (upload is via SVN, any > > committer > > has rights, *changes are instant*) > > > > On Fri, Feb 2, 2018 at 2:05 AM, Denis Magda <dma...@apache.org> wrote: > > > > > Dmitriy, > > > > > > We will do a research before jumping off the readme.io < > > http://readme.io/> > > > train. > > > > > > In addition, to the technical issues outlined in the ticket, readme.io > < > > > http://readme.io/> doesn’t give a way to tell Google “Hey, Google, > index > > > only the latest docs' version! Ignore specific versions”. As a result, > > the > > > Internet is flooded with Ignite 1.1, 1.7, 1.9 versions of the pages > that > > > pop up at the top of the search. You know this annoying thing better > than > > > me :) > > > > > > — > > > Denis > > > > > > > On Feb 1, 2018, at 1:39 PM, Dmitriy Setrakyan <dsetrak...@apache.org > > > > > wrote: > > > > > > > > Guys, as I have been saying all along, we need to identify a > > > documentation > > > > system we want to move to. Once we do that, we can plan how to move > off > > > of > > > > readme. > > > > > > > > Again, the most important benefit readme has is instantaneous > > > documentation > > > > update. However, on the downside, they do not integrate with Git > well, > > > and > > > > ASF wants all its projects to keep the documentation in Apache Git. > > > > > > > > Does anyone have suggestions? > > > > > > > > D. > > > > > > > > On Thu, Feb 1, 2018 at 5:57 AM, Pavel Tupitsyn <ptupit...@apache.org > > > > > wrote: > > > > > > > >> Good news, Denis. > > > >> > > > >> By the way, readme.io uses some kind of markdown dialect, and they > > have > > > >> "export" feature, > > > >> so it should be possible to move to some markdown-based system like > > > Jekyll > > > >> without too much hassle. > > > >> > > > >> On Thu, Feb 1, 2018 at 2:18 AM, Denis Magda <dma...@apache.org> > > wrote: > > > >> > > > >>> Created a ticket. I think the time to move from readme.io < > > > >>> http://readme.io/> has come. It’s becoming too challenging to live > > > with > > > >>> it: > > > >>> https://issues.apache.org/jira/browse/IGNITE-7595 < > > > >>> https://issues.apache.org/jira/browse/IGNITE-7595> > > > >>> > > > >>> — > > > >>> Denis > > > >>> > > > >>>> On Apr 13, 2017, at 8:25 AM, Dmitriy Setrakyan < > > dsetrak...@apache.org > > > > > > > >>> wrote: > > > >>>> > > > >>>> On Wed, Apr 12, 2017 at 8:52 PM, Konstantin Boudnik < > c...@apache.org > > > > > > >>> wrote: > > > >>>> > > > >>>>> I hate to be that guy, but mentors warned this very project no to > > do > > > >>>>> this in the first place. At least once [1] on the dev@, and a > few > > > >>>>> times off-line > > > >>>>> > > > >>>> > > > >>>> Cos, no doubt this had come up before (after all, we did have very > > > good > > > >>>> mentors during the incubation process). > > > >>>> > > > >>>> Unfortunately, for tasks like this it is never a good time. I hope > > > >>> someone > > > >>>> in the community picks it up, or at least gets started on it. > > > >>> > > > >>> > > > >> > > > > > > > > > > > > -- > Alexey Kuznetsov >
