Re: Move documentation from readme.io to GitHub pages

I did a very shallow research on Jekyll. Work flow seemed similar to Docusaurus but more flexible in terms of directory structure- how docs can be placed in the repo (Docusaurus requires docs to be stored in a particular directory structure), as well as sidebar menu ( Docusaurus does not allow chil

Re: Move documentation from readme.io to GitHub pages

Look into both Docusaraus and Jekyll from the usage perspective. Here is my summary: *Documentation Sources * Will be stored on GitHub. My preference is to store them in "ignite/docs" folder as many other ASF projects do (Spark [1], Flink [2] and Storm [3]). If we need to update the sources of an

Re: Move documentation from readme.io to GitHub pages

On Wed, Mar 21, 2018 at 9:27 PM, Prachi Garg wrote: > We can store the project (Markdown & Docusaurus config files) in Git, use > Docusaurus to build html, and upload them to Ignite website. > Sounds good!

Re: Move documentation from readme.io to GitHub pages

We can store the project (Markdown & Docusaurus config files) in Git, use Docusaurus to build html, and upload them to Ignite website. On Tue, Mar 20, 2018 at 10:29 PM, Dmitriy Setrakyan wrote: > Does docusaurus work with GitHub only, or with Git in general? In Apache > GitHub is used as a mirro

Re: Move documentation from readme.io to GitHub pages

Does docusaurus work with GitHub only, or with Git in general? In Apache GitHub is used as a mirror of an internal Git repo, which is the primary source of data. D.

Re: Move documentation from readme.io to GitHub pages

Copied from the ticket. *Feature* *Docusaurus* *GitBook* *Free* Yes (FaceBook open source project) Yes (Free version only allows 5 contributors) *Setup and Installation* Easy installation and configuration steps. Initial setup is easy; Need to look around for customization. *Standard Mark

Re: Move documentation from readme.io to GitHub pages

I looked into Docusaurus and GitBook. I liked Docusaurus better because it allows publishing to github pages or other static files hosts, and various other features. My findings are mentioned in the ticket - https://issues.apache.org/jira/browse/IGNITE-7595 . On Fri, Feb 2, 2018 at 2:42 PM, Denis

Re: Move documentation from readme.io to GitHub pages

Looks promising. Thanks for sharing. Updated the ticket. — Denis > On Feb 2, 2018, at 2:25 PM, Dmitriy Setrakyan wrote: > > I think docusaurus.io could work for us. Denis, what do you think? > > On Fri, Feb 2, 2018 at 3:10 AM, endianignite wrote: > >> I noticed that Facebook open-sourced a d

Re: Move documentation from readme.io to GitHub pages

I think docusaurus.io could work for us. Denis, what do you think? On Fri, Feb 2, 2018 at 3:10 AM, endianignite wrote: > I noticed that Facebook open-sourced a documentation platform last month, > https://docusaurus.io/, which may be worth considering. > > > > > > -- > Sent from: http://apache-i

Re: Move documentation from readme.io to GitHub pages

I noticed that Facebook open-sourced a documentation platform last month, https://docusaurus.io/, which may be worth considering. -- Sent from: http://apache-ignite-developers.2346864.n4.nabble.com/

Re: Move documentation from readme.io to GitHub pages

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 wrote: > Pavel, > > Do I correctly un

Re: Move documentation from readme.io to GitHub pages

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 wrote: > I did some research for my blog some time ago, and proposal is: > > * Export markdown from Readme.io (

Re: Move documentation from readme.io to GitHub pages

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 HT

Re: Move documentation from readme.io to GitHub pages

Dmitriy, We will do a research before jumping off the readme.io train. In addition, to the technical issues outlined in the ticket, readme.io doesn’t give a way to tell Google “Hey, Google, index only the latest docs' version! Ignore specific versions”.

Re: Move documentation from readme.io to GitHub pages

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

Re: Move documentation from readme.io to GitHub pages

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 wrote: > Created a ticket. I think the time

Re: Move documentation from readme.io to GitHub pages

Created a ticket. I think the time to move from readme.io has come. It’s becoming too challenging to live with it: https://issues.apache.org/jira/browse/IGNITE-7595 — Denis > On Apr 13, 2017, at 8:25 AM, Dmitriy Setrakyan

Re: Move documentation from readme.io to GitHub pages

On Wed, Apr 12, 2017 at 8:52 PM, Konstantin Boudnik 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

Re: Move documentation from readme.io to GitHub pages

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 [1] https://is.gd/ZRPOrH Cos -- Take care, Konstantin (Cos) Boudnik 2CAC 8312 4870 D885 8616 6115 220F 6980 1F27 E622 Disclaimer: Opinions exp

Re: Move documentation from readme.io to GitHub pages

Pavel, We all agree that the documentation should be in our GIT repo in either Markdown or AsciiDoc format. However, it is a very big undertaking to migrate it from readme and properly structure it. If anyone in the community would volunteer, would be great. D. On Tue, Apr 11, 2017 at 9:36 PM, P

Re: Move documentation from readme.io to GitHub pages

> Git approach is no way to go for us because all the documentation has to be hosted on ASF side Well, our Git repository [1] is hosted by ASF, isn't it? GitHub pages just generates HTML from MarkDown via Jekyll [2] static site generator. I understand the concern about GitHub pages, though. And I

Re: Move documentation from readme.io to GitHub pages

Pavel, I totally agree that it’s becoming more and more inconvenient to run the documentation on readme.io . At the same time the Git approach is no way to go for us because all the documentation has to be hosted on ASF side. Presently we violate this policy and I look forwar

Re: Move documentation from readme.io to GitHub pages

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 wrote: > Igniters, > > Currently we host documentation on > apacheignite.readme.io (and also apache

Move documentation from readme.io to GitHub pages

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 someth