Re: Let's keep Apache Ignite docs up-to-date

Guys, The migration process is in the progress. Here is a discussion where we exchanged alternate doc engines (let's keep talking there): http://apache-ignite-developers.2346864.n4.nabble.com/Move-documentation-from-readme-io-to-GitHub-pages-td16409.html Add to the JIRA ticket as a watcher if

Re: Let's keep Apache Ignite docs up-to-date

Hi, Igniters Missed this discussion +1 for git docs, as far as i can see this approach is used by many projects and it seems to be quite good. On 6 March 2018 at 11:44, Alexey Goncharuk wrote: > Igniters, > > Bumping up this discussion. > > I have recently found

Re: Let's keep Apache Ignite docs up-to-date

Igniters, Bumping up this discussion. I have recently found out that we have this process for documenting new releases [1] which looks quite ridiculous to me. First, creating a copy of page with next-version suffix is inconvenient and error-prone: the next-version page is not visible to anyone,

Re: Let's keep Apache Ignite docs up-to-date

I don't like git docs idea, it will require to follow whole PR-review-process that requires long time. IMO it is odd work. If readme.io provides review process, I suggest to keep it as-is. чт, 2 нояб. 2017 г. в 9:57, Dmitriy Setrakyan : > On Wed, Nov 1, 2017 at 11:27 PM,

Re: Let's keep Apache Ignite docs up-to-date

On Wed, Nov 1, 2017 at 11:27 PM, Vladimir Ozerov wrote: > +1 for moving docs under Git provided that we find a way to update docs > outside of AI release as it is possible now with readme.io. > I am HUGE +1 for that. The whole problem is that we haven't found a way yet.

Re: Let's keep Apache Ignite docs up-to-date

+1 for moving docs under Git provided that we find a way to update docs outside of AI release as it is possible now with readme.io. On Thu, Nov 2, 2017 at 8:57 AM, Pavel Tupitsyn wrote: > > I can edit a document and it is visible to the whole world once I click a > save

Re: Let's keep Apache Ignite docs up-to-date

I am going to repeat my previous comment, since it somehow got lost in the discussion: The main value of readme is that I can edit a document and it is visible to the whole world once I click a save button, without any git commands or builds. If anyone in the community can suggest a tool that

Re: Let's keep Apache Ignite docs up-to-date

+1 to Pavel's proposal, > Markdown can also be visualized by many IDEs, so it is easy to edit locally. IDEA shows Markdown out of the box. Yakov, > having docs under separate git repository We should not use separate git repo, Apache Ignite repo should be used. Documentation should be a part of

Re: Let's keep Apache Ignite docs up-to-date

Denis, > Could you show me any example of such a documentation where docs are stored in git and can be visualized by GitHub (dev stage) and 3rd party engine (release on the site)? 1) Apache Spark Source: https://github.com/apache/spark/tree/master/docs Docs:

Re: Let's keep Apache Ignite docs up-to-date

On Tue, Oct 31, 2017 at 8:15 PM, Yakov Zhdanov wrote: > I would also consider having docs under separate git repository. Separate > since we need to have an opportunity to revisit documentation for already > released versions. > This should not be a problem.

Re: Let's keep Apache Ignite docs up-to-date

I would also consider having docs under separate git repository. Separate since we need to have an opportunity to revisit documentation for already released versions. --Yakov

Re: Let's keep Apache Ignite docs up-to-date

The main value of readme is that I can edit a document and it is visible to the whole world once I click a save button, without any git commands or builds. If anyone in the community can suggest a tool that will work the same way with Apache git repository directly, please send it here. D. On

Re: Let's keep Apache Ignite docs up-to-date

Anton, The life is not about coding only :) Sometimes we need to learn new tools to produce nice looking, well organized and professional content. Take Photopshop or Mac Keynote for instance that help us out with diagrams and presentations creation. Readme.io does it job

Re: Let's keep Apache Ignite docs up-to-date

Pavel, Could you show me any example of such a documentation where docs are stored in git and can be visualized by GitHub (dev stage) and 3rd party engine (release on the site)? In my understanding if take your approach then the community needs to develop a visualization engine for

Re: Let's keep Apache Ignite docs up-to-date

Simplified: Current flow is over-complicated for me as developer, I see a lot of problems and have no clue how to fix them using readme.io or wiki. But I know how to fix them using git. I'm good at git, let me write documentation in way I'm good in :) On Tue, Oct 31, 2017 at 7:29 PM, Pavel

Re: Let's keep Apache Ignite docs up-to-date

> easy to use editor Honestly, it sucks. I want to use my IDE and git instead of slow and buggy browser-based bs. > commit changes This is a good thing. I want to commit changes, see history, do other VCS stuff. > Github is also a third-party site I don't suggest github. We store code in Apache

Re: Let's keep Apache Ignite docs up-to-date

Hi Pavel, The lack of smooth versioning between pages on readme.io is redeemed with an easy to use editor. A doc writer don’t need to grasp any markup language, commit changes to some remote repo and check up final results. All the writer needs to do is to open a page and

Re: Let's keep Apache Ignite docs up-to-date

+1 to git case. On Tue, Oct 31, 2017 at 12:35 PM, Pavel Tupitsyn wrote: > Hi Denis, > > Are there plans to move away from readme.io? > > * It is not properly versioned, which is very painful > * Documentation should be in Apache git, not on some third party site > >

Re: Let's keep Apache Ignite docs up-to-date

Hi Denis, Are there plans to move away from readme.io? * It is not properly versioned, which is very painful * Documentation should be in Apache git, not on some third party site Thoughts? On Mon, Oct 30, 2017 at 11:24 PM, Denis Magda wrote: > Good point. Renamed: >

Re: Let's keep Apache Ignite docs up-to-date

Good point. Renamed: https://cwiki.apache.org/confluence/display/IGNITE/How+to+Document — Denis > On Oct 30, 2017, at 12:37 PM, Dmitriy Setrakyan wrote: > > Thanks Denis! Any change we can rename the

Re: Let's keep Apache Ignite docs up-to-date

Thanks Denis! Any change we can rename the page to "How to Document?". On Mon, Oct 30, 2017 at 12:27 PM, Denis Magda wrote: > Igniters, > > Our project is broadly documented so it’s becoming harder and harder to > keep the docs consistent and updated. During several last