Pavel, I totally agree with you, but what about documentations for different versions? How do you suppose to solve this problem with GitHub pages?
On Tue, Apr 11, 2017 at 12:02 PM, Pavel Tupitsyn <ptupit...@apache.org> wrote: > Igniters, > > Currently we host documentation on > apacheignite.readme.io (and also apacheignite-net.readme.io, > apacheignite-cpp.readme.io, apacheignite-mix.readme.io, etc). > > readme.io has a lot of problems mostly due to lack of proper version > control: > * Each "version" is just a copy. When fixing something, you have to update > all versions. > * No good way to review changes. > * "Propose edit" functionality is a joke. You can only accept or reject an > edit, no way to communicate with contributor, etc > > GitHub Pages solves all these problems: > https://github.com/blog/2233-publish-your-project- > documentation-with-github-pages > > Basically, we'll have a separate folder in our Git repository where > documentation is stored in markdown format. > This way the process for updating docs is exactly the same as any other > code change. > Pull request with new feature can contain the docs for this feature, and so > on. > > Thoughts? >
