Hi folks,

At the moment, the "Docs" link at the top menu bar [1] is linked to a
non-ASF URL [2].
I don't think we can keep the non-ASF pages there in the future.
Furthermore, the documentation there is outdated from the
documentation source at doc/.

Our official documentation repository is the SVN [3], as of [4].

Therefore, I'd like to propose the following:
1. Initially one of the committers should generate the site html from
the doc/ in git source repo, following the instruction in
doc/readme.md, until `make html`, which generates all the html and
other static resource files at docs/build/html/. (I've just tested and
it works fine.)
   And, the generated files at docs/build/html/** should be committed
to a new directory, "docs", in [3].
2. Change the "Docs" menu link to "docs/index.html" from the external link.
3. From now on, whenever committers update documentation, once in a
while, do the step 1 and 2 periodically, to synchronize the online
site with the documentation source.

When we really want to expand the community during the incubation
period, the online documentation is really crucial: new comers start
from there...

Any thoughts?
If this sounds okay, any volunteers?

Regards,

Woonsan

[1] http://s2graph.incubator.apache.org/
[2] https://steamshon.gitbooks.io/s2graph-book/content/
[3] http://svn.apache.org/repos/asf/incubator/s2graph/site/
[4] https://issues.apache.org/jira/browse/INFRA-11806

Reply via email to