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 Tue, Oct 31, 2017 at 10:56 AM, Denis Magda <dma...@apache.org> wrote: > 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 <http://readme.io/> does it job well as a tool for technical > writers. > > — > Denis > > > On Oct 31, 2017, at 9:47 AM, Anton Vinogradov <a...@apache.org> wrote: > > > > 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 Tupitsyn <ptupit...@apache.org> > > wrote: > > > >>> 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 git [1], and we should store docs there as well, > >> as most projects do. > >> > >> This way documentation can be developed, reviewed and merged with > exactly > >> the same process as used for code, which is great. > >> > >> ignite.apache.org should be used for hosting. > >> Documentation release will be the same as source/binary/javadoc release: > >> just push things to SVN. > >> > >> > >> Thanks, > >> Pavel > >> > >> > >> [1] https://git-wip-us.apache.org/repos/asf/ignite > >> > >> On Tue, Oct 31, 2017 at 7:13 PM, Denis Magda <dma...@apache.org> wrote: > >> > >>> Hi Pavel, > >>> > >>> The lack of smooth versioning between pages on readme.io < > >>> http://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 update it seeing the changes immediately. > >>> > >>> Github is also a third-party site, so the docs won’t be hosted on ASF > >>> infrastructure anyway. > >>> > >>> As a the one who prepares docs frequently, I can live with readme.io < > >>> http://readme.io/>. > >>> > >>> — > >>> Denis > >>> > >>>> On Oct 31, 2017, at 2:35 AM, Pavel Tupitsyn <ptupit...@apache.org> > >>> 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 > >>>> > >>>> Thoughts? > >>>> > >>>> On Mon, Oct 30, 2017 at 11:24 PM, Denis Magda <dma...@apache.org> > >> wrote: > >>>> > >>>>> Good point. Renamed: > >>>>> https://cwiki.apache.org/confluence/display/IGNITE/How+to+Document < > >>>>> https://cwiki.apache.org/confluence/display/IGNITE/How+to+Document> > >>>>> > >>>>> — > >>>>> Denis > >>>>> > >>>>>> On Oct 30, 2017, at 12:37 PM, Dmitriy Setrakyan < > >> dsetrak...@apache.org > >>>> > >>>>> wrote: > >>>>>> > >>>>>> Thanks Denis! Any change we can rename the page to "How to > >> Document?". > >>>>>> > >>>>>> On Mon, Oct 30, 2017 at 12:27 PM, Denis Magda <dma...@apache.org> > >>> wrote: > >>>>>> > >>>>>>> Igniters, > >>>>>>> > >>>>>>> Our project is broadly documented so it’s becoming harder and > harder > >>> to > >>>>>>> keep the docs consistent and updated. During several last months we > >>>>> tried > >>>>>>> the new approach with some of community members and took it down on > >>>>> paper: > >>>>>>> https://cwiki.apache.org/confluence/display/IGNITE/Documentation > >>>>>>> > >>>>>>> Please read it through and keep to it going forward or propose your > >>>>>>> changes if you’re like. Presently this approach proved to be > >>> effective. > >>>>>>> > >>>>>>> — > >>>>>>> Denis > >>>>> > >>>>> > >>> > >>> > >> > >
