[GitHub] [incubator-s2graph] woonsan opened a new pull request #196: Use variables for curl example base url with localhost:8000 as default

[GitBox]

woonsan opened a new pull request #196: Use variables for curl example base url 
with localhost:8000 as default
URL: https://github.com/apache/incubator-s2graph/pull/196
 
 
   I've added a configuration for curl example base url and let each rst source 
refer to the variable for interpolation.
   As the variable is used in code block, I also had to replace `.. code:: 
bash` with `.. parsed-literal::`. `curl` command examples actually do not get 
much benefit from `.. code:: bash`, so I think `.. parsed-literal::` is good 
enough for the purpose.
   And, I removed the sentence mentioning `script/test.sh` and 
`design/data_model` page reference because they don't exist and make logs 
errors.
   Please review the changes and merge it if okay.
   Thanks!


This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org


With regards,
Apache Git Services

Re: Documentation to the official online site svn?

[Woonsan Ko]

Thanks a lot, Do Yung, as always!
Please tell me if there's anything I can help with.

Cheers,

Woonsan

On Tue, Mar 5, 2019 at 12:12 AM DO YUNG YOON  wrote:
>
> Hi Woonsan.
>
> I agree with your suggestion, and I am volunteering for this.
> Let me try working on this on weekends then I will share any
> questions/updates.
>
> Thanks for your suggestion.
>
>
> On Tue, Mar 5, 2019 at 11:27 AM Woonsan Ko  wrote:
>
> > 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
> >