The link available now.
http://usergrid.readthedocs.org/en/latest/index.html
<http://usergrid.readthedocs.org/en/latest/index.html>
https://readthedocs.org/projects/usergrid/
<https://readthedocs.org/projects/usergrid/>
If we want to change or update docs,
1) Push changes on master branch
2) Manual build
Rod, can you tell me your readthedocs.org accout? I can add you as admin.
As I mention before, we can also possible automatically.
> On Nov 4, 2014, at 9:28 AM, Sungju Jin <[email protected]> wrote:
>
> There are two options.
>
> 1) Automatically builds using git-post-hook[1]. I think we possible if we ask
> to infrastructure team[2]
> 2) Manual update, not good. However, so easy.
>
> [1] http://read-the-docs.readthedocs.org/en/latest/webhooks.html#github
> <http://read-the-docs.readthedocs.org/en/latest/webhooks.html#github>
> [2] https://issues.apache.org/jira/browse/INFRA-6683
> <https://issues.apache.org/jira/browse/INFRA-6683>
>> On Nov 4, 2014, at 9:02 AM, Rod Simpson <[email protected]
>> <mailto:[email protected]>> wrote:
>>
>> How would we get changes into readthedocs?
>>
>>
>>
>> --
>> Rod Simpson
>> @rockerston <https://twitter.com/rockerston>
>> rodsimpson.com <http://rodsimpson.com/>
>> On November 3, 2014 at 4:49:07 PM, Sungju Jin ([email protected]
>> <mailto:[email protected]>) wrote:
>>
>>> Yes, currently new way have to commit both. that means you have to push
>>> source(markdown) into git and then commit html files into svn.
>>> If we don’t care about url, we can use a readthedocs hosting such as
>>> libcloud[1].
>>> Of course, I prefer using readthedocs hosting. I have to change if we take
>>> this.
>>> What do you think?
>>>
>>> https://libcloud.readthedocs.org/en/latest/
>>> <https://libcloud.readthedocs.org/en/latest/>
>>> <https://libcloud.readthedocs.org/en/latest/
>>> <https://libcloud.readthedocs.org/en/latest/>>
>>>
>>>
>>> > On Nov 4, 2014, at 8:30 AM, Rod Simpson <[email protected]
>>> > <mailto:[email protected]>> wrote:
>>> >
>>> > So I guess I am confused as to the flow for getting this into our SVN
>>> > (where the docs live). Are we going to commit it to git, then commit to
>>> > SVN?
>>> >
>>> >
>>> >
>>> >
>>> >
>>> > --
>>> > Rod Simpson
>>> > @rockerston <https://twitter.com/rockerston
>>> > <https://twitter.com/rockerston>>
>>> > rodsimpson.com <http://rodsimpson.com/> <http://rodsimpson.com/
>>> > <http://rodsimpson.com/>>
>>> > On November 3, 2014 at 4:21:43 PM, Sungju Jin ([email protected]
>>> > <mailto:[email protected]> <mailto:[email protected]
>>> > <mailto:[email protected]>>) wrote:
>>> >
>>> >> Rod,
>>> >>
>>> >> Thank you for your comment! I already send a PR. You can review and
>>> >> merge a PR.
>>> >> https://github.com/apache/incubator-usergrid/pull/86
>>> >> <https://github.com/apache/incubator-usergrid/pull/86>
>>> >> <https://github.com/apache/incubator-usergrid/pull/86
>>> >> <https://github.com/apache/incubator-usergrid/pull/86>>
>>> >> <https://github.com/apache/incubator-usergrid/pull/86
>>> >> <https://github.com/apache/incubator-usergrid/pull/86>
>>> >> <https://github.com/apache/incubator-usergrid/pull/86
>>> >> <https://github.com/apache/incubator-usergrid/pull/86>>>
>>> >>
>>> >> Regards,
>>> >> Sungju
>>> >>
>>> >>
>>> >> > On Nov 4, 2014, at 7:51 AM, Rod Simpson <[email protected]
>>> >> > <mailto:[email protected]> <mailto:[email protected]
>>> >> > <mailto:[email protected]>>> wrote:
>>> >> >
>>> >> > Sungju,
>>> >> >
>>> >> > This looks awesome and would be a great addition. I don’t think we
>>> >> > need to take a vote on this (someone correct me if I am wrong). But I
>>> >> > think you can go ahead and push your changes.
>>> >> >
>>> >> > Rod
>>> >> >
>>> >> > --
>>> >> > Rod Simpson
>>> >> > @rockerston <https://twitter.com/rockerston
>>> >> > <https://twitter.com/rockerston> <https://twitter.com/rockerston
>>> >> > <https://twitter.com/rockerston>>>
>>> >> > rodsimpson.com <http://rodsimpson.com/> <http://rodsimpson.com/
>>> >> > <http://rodsimpson.com/>> <http://rodsimpson.com/
>>> >> > <http://rodsimpson.com/> <http://rodsimpson.com/
>>> >> > <http://rodsimpson.com/>>>
>>> >> > On October 21, 2014 at 7:04:50 AM, Sungju Jin
>>> >> > ([email protected] <mailto:[email protected]>
>>> >> > <mailto:[email protected] <mailto:[email protected]>>
>>> >> > <mailto:[email protected] <mailto:[email protected]>
>>> >> > <mailto:[email protected] <mailto:[email protected]>>>)
>>> >> > wrote:
>>> >> >
>>> >> >> Thank you for your comments. Also batchee link helps me.
>>> >> >> I’m not sure community wants to integrate docs into our
>>> >> >> git(https://git-wip-us.apache.org/repos/asf/incubator-usergrid.git
>>> >> >> <https://git-wip-us.apache.org/repos/asf/incubator-usergrid.git>
>>> >> >> <https://git-wip-us.apache.org/repos/asf/incubator-usergrid.git
>>> >> >> <https://git-wip-us.apache.org/repos/asf/incubator-usergrid.git>>
>>> >> >> <https://git-wip-us.apache.org/repos/asf/incubator-usergrid.git
>>> >> >> <https://git-wip-us.apache.org/repos/asf/incubator-usergrid.git>
>>> >> >> <https://git-wip-us.apache.org/repos/asf/incubator-usergrid.git
>>> >> >> <https://git-wip-us.apache.org/repos/asf/incubator-usergrid.git>>>)
>>> >> >> As you know, it’s simple technically. However, I think it means
>>> >> >> contribution flow changes.
>>> >> >> So, I’d like to get more other thinking(agreed or disagreed)
>>> >> >>
>>> >> >> If I change this,
>>> >> >>
>>> >> >> 1. Creating a docs module (maven)
>>> >> >> 2. Putting md files into git
>>> >> >> 3. Generating docs that use sphinx-maven plugin[1] when we push our
>>> >> >> site
>>> >> >>
>>> >> >> [1] https://github.com/tomdz/sphinx-maven
>>> >> >> <https://github.com/tomdz/sphinx-maven>
>>> >> >> <https://github.com/tomdz/sphinx-maven
>>> >> >> <https://github.com/tomdz/sphinx-maven>>
>>> >> >> <https://github.com/tomdz/sphinx-maven
>>> >> >> <https://github.com/tomdz/sphinx-maven>
>>> >> >> <https://github.com/tomdz/sphinx-maven
>>> >> >> <https://github.com/tomdz/sphinx-maven>>>
>>> >> >> <https://github.com/tomdz/sphinx-maven
>>> >> >> <https://github.com/tomdz/sphinx-maven>
>>> >> >> <https://github.com/tomdz/sphinx-maven
>>> >> >> <https://github.com/tomdz/sphinx-maven>>
>>> >> >> <https://github.com/tomdz/sphinx-maven
>>> >> >> <https://github.com/tomdz/sphinx-maven>
>>> >> >> <https://github.com/tomdz/sphinx-maven
>>> >> >> <https://github.com/tomdz/sphinx-maven>>>>
>>> >> >>
>>> >> >>
>>> >> >> > 2014. 10. 21., 오후 7:57, John D. Ament <[email protected]
>>> >> >> > <mailto:[email protected]> <mailto:[email protected]
>>> >> >> > <mailto:[email protected]>>> 작성:
>>> >> >> >
>>> >> >> > Hi,
>>> >> >> >
>>> >> >> > In a number of other projects out there in apache land, we're doing
>>> >> >> > similar
>>> >> >> > types of integration. WDYT about storing your MD files in your git
>>> >> >> > repo as
>>> >> >> > a first step, and using a site style integration to generate (via
>>> >> >> > maven)
>>> >> >> > the content and push to your website?
>>> >> >> >
>>> >> >> > Then once you're satisfied you can publish.
>>> >> >> >
>>> >> >> > You can see an example of how BatchEE does it at [1]
>>> >> >> >
>>> >> >> > - John
>>> >> >> >
>>> >> >> > [1]:
>>> >> >> > https://github.com/apache/incubator-batchee/blob/master/pom.xml#L427
>>> >> >> >
>>> >> >> > <https://github.com/apache/incubator-batchee/blob/master/pom.xml#L427>
>>> >> >> >
>>> >> >> > <https://github.com/apache/incubator-batchee/blob/master/pom.xml#L427
>>> >> >> >
>>> >> >> > <https://github.com/apache/incubator-batchee/blob/master/pom.xml#L427>>
>>> >> >> >
>>> >> >> >
>>> >> >> >
>>> >> >> >
>>> >> >> > On Mon, Oct 20, 2014 at 10:40 PM, Lewis John Mcgibbney <
>>> >> >> > [email protected] <mailto:[email protected]>
>>> >> >> > <mailto:[email protected]
>>> >> >> > <mailto:[email protected]>>> wrote:
>>> >> >> >
>>> >> >> >> Hi Sungju,
>>> >> >> >>
>>> >> >> >> On Mon, Oct 20, 2014 at 7:01 PM, <
>>> >> >> >> [email protected]
>>> >> >> >> <mailto:[email protected]>
>>> >> >> >> <mailto:[email protected]
>>> >> >> >> <mailto:[email protected]>>
>>> >> >> >> <mailto:[email protected]
>>> >> >> >> <mailto:[email protected]>
>>> >> >> >> <mailto:[email protected]
>>> >> >> >> <mailto:[email protected]>>>> wrote:
>>> >> >> >>
>>> >> >> >>> Can we change document system?
>>> >> >> >>> Currently the docs system is not easy to contribute and manage
>>> >> >> >>> the
>>> >> >> >>> version, search in the docs.
>>> >> >> >>>
>>> >> >> >>
>>> >> >> >> Point taken, this has been flagged up elsewhere recently as well.
>>> >> >> >>
>>> >> >> >>
>>> >> >> >>> I have been working changing docs system to sphinx (readthedocs
>>> >> >> >>> theme)
>>> >> >> >>> from our ruby generator. If we want to change, the doc
>>> >> >> >>> repository(svn)
>>> >> >> >> has to
>>> >> >> >>> integrate our git(https://github.com/apache/incubator-usergrid
>>> >> >> >>> <https://github.com/apache/incubator-usergrid>
>>> >> >> >>> <https://github.com/apache/incubator-usergrid
>>> >> >> >>> <https://github.com/apache/incubator-usergrid>>
>>> >> >> >>> <https://github.com/apache/incubator-usergrid
>>> >> >> >>> <https://github.com/apache/incubator-usergrid>
>>> >> >> >>> <https://github.com/apache/incubator-usergrid
>>> >> >> >>> <https://github.com/apache/incubator-usergrid>>>) as well.
>>> >> >> >>>
>>> >> >> >>
>>> >> >> >> Not sure if this is where we want it to be pointing.
>>> >> >> >> I feel that this should probably be
>>> >> >> >> https://git-wip-us.apache.org/repos/asf/incubator-usergrid.git
>>> >> >> >> <https://git-wip-us.apache.org/repos/asf/incubator-usergrid.git>
>>> >> >> >> <https://git-wip-us.apache.org/repos/asf/incubator-usergrid.git
>>> >> >> >> <https://git-wip-us.apache.org/repos/asf/incubator-usergrid.git>>
>>> >> >> >> <https://git-wip-us.apache.org/repos/asf/incubator-usergrid.git
>>> >> >> >> <https://git-wip-us.apache.org/repos/asf/incubator-usergrid.git>
>>> >> >> >> <https://git-wip-us.apache.org/repos/asf/incubator-usergrid.git
>>> >> >> >> <https://git-wip-us.apache.org/repos/asf/incubator-usergrid.git>>>
>>> >> >> >>
>>> >> >> >>
>>> >> >> >>
>>> >> >> >>>
>>> >> >> >>> Benefits
>>> >> >> >>> - Easily Contribute than before (directly git)
>>> >> >> >>> - Improve Search
>>> >> >> >>> - Support pdf, other formats
>>> >> >> >>>
>>> >> >> >>
>>> >> >> >> Are all of these still relevant if we specify the Apache hosted
>>> >> >> >> Git code?
>>> >> >> >> Can you review again and comment?
>>> >> >> >>
>>> >> >> >>
>>> >> >> >>>
>>> >> >> >>> Look at the attached prototype screenshot. What do you think? Any
>>> >> >> >>>
>>> >> >> >> feedback
>>> >> >> >>> is welcome.
>>> >> >> >>>
>>> >> >> >>>
>>> >> >> >>> Attachment of any kind are stripped from mailing lists.
>>> >> >> >> Would be great if you could make the screenshot available some
>>> >> >> >> other way.
>>> >> >> >> Thanks
>>> >> >> >> Lewis
>>> >> >> >>
>
