<div dir="auto"><div><br><div class="gmail_extra"><br><div class="gmail_quote">On Jan 4, 2017 6:08 PM, "Petr Horacek" <<a href="mailto:phoracek@redhat.com">phoracek@redhat.com</a>> wrote:<br type="attribution"><blockquote class="quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">Hello again, built master documentation is available on [1], latest<br>
4.1 and 4.0 tags on [2] and [3] (these two were created manually,<br>
automated build will be triggered by a next tag).<br>
<br>
[1] <a href="http://ovirt.github.io/ovirt-engine-api-model/master/" rel="noreferrer" target="_blank">http://ovirt.github.io/ovirt-<wbr>engine-api-model/master/</a><br>
[2] <a href="http://ovirt.github.io/ovirt-engine-api-model/4.1/" rel="noreferrer" target="_blank">http://ovirt.github.io/ovirt-<wbr>engine-api-model/4.1/</a><br>
[3] <a href="http://ovirt.github.io/ovirt-engine-api-model/4.0/" rel="noreferrer" target="_blank">http://ovirt.github.io/ovirt-<wbr>engine-api-model/4.0/</a></blockquote></div></div></div><div dir="auto"><br></div><div dir="auto">Well done! A post to the users mailing list + blog post on <a href="http://ovirt.org">ovirt.org</a> would make it more visible. </div><div dir="auto">Y. </div><div dir="auto"><br></div><div dir="auto"><div class="gmail_extra"><div class="gmail_quote"><blockquote class="quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex"><br>
<div class="elided-text"><br>
2017-01-03 15:22 GMT+01:00 Juan Hernández <<a href="mailto:jhernand@redhat.com">jhernand@redhat.com</a>>:<br>
> On 01/03/2017 03:20 PM, Petr Horacek wrote:<br>
>> Hi, I've been hacking public API docs yesterday, and I think it will<br>
>> work in GitHub-Travis combination. Now I am waiting if Gerrit-GitHub<br>
>> mirroring will remove branch created directly on GitHub, if not, then<br>
>> my approach would be following:<br>
>><br>
>> Both 4.0 and 4.1 branches will have .travis.yml in them that will run<br>
>> the build and then push generated pages to gh-pages branch (authorized<br>
>> via GitHub deploy key). For now I have a working demo on my fork<br>
>> (<a href="https://github.com/phoracek/ovirt-engine-api-model/blob/master/.travis.yml" rel="noreferrer" target="_blank">https://github.com/phoracek/<wbr>ovirt-engine-api-model/blob/<wbr>master/.travis.yml</a>),<br>
>> this one does not use deploy keys, but token instead.<br>
>><br>
>> Hope I'm not breaking your work.<br>
>><br>
><br>
> Excellent! Please go ahead.<br>
><br>
>> 2017-01-03 14:49 GMT+01:00 Vojtech Szocs <<a href="mailto:vszocs@redhat.com">vszocs@redhat.com</a>>:<br>
>>><br>
>>><br>
>>> ----- Original Message -----<br>
>>>> From: "Rafael Martins" <<a href="mailto:rmartins@redhat.com">rmartins@redhat.com</a>><br>
>>>> To: "Vojtech Szocs" <<a href="mailto:vszocs@redhat.com">vszocs@redhat.com</a>><br>
>>>> Cc: "Juan Hernández" <<a href="mailto:jhernand@redhat.com">jhernand@redhat.com</a>>, "Michal Skrivanek" <<a href="mailto:mskrivan@redhat.com">mskrivan@redhat.com</a>>, "devel" <<a href="mailto:devel@ovirt.org">devel@ovirt.org</a>><br>
>>>> Sent: Tuesday, January 3, 2017 2:28:30 PM<br>
>>>> Subject: Re: [ovirt-devel] Publicly available REST documentation<br>
>>>><br>
>>>><br>
>>>><br>
>>>> ----- Original Message -----<br>
>>>>> From: "Vojtech Szocs" <<a href="mailto:vszocs@redhat.com">vszocs@redhat.com</a>><br>
>>>>> To: "Rafael Martins" <<a href="mailto:rmartins@redhat.com">rmartins@redhat.com</a>><br>
>>>>> Cc: "Juan Hernández" <<a href="mailto:jhernand@redhat.com">jhernand@redhat.com</a>>, "Michal Skrivanek"<br>
>>>>> <<a href="mailto:mskrivan@redhat.com">mskrivan@redhat.com</a>>, "devel" <<a href="mailto:devel@ovirt.org">devel@ovirt.org</a>><br>
>>>>> Sent: Tuesday, January 3, 2017 2:24:22 PM<br>
>>>>> Subject: Re: [ovirt-devel] Publicly available REST documentation<br>
>>>>><br>
>>>>><br>
>>>>><br>
>>>>> ----- Original Message -----<br>
>>>>>> From: "Rafael Martins" <<a href="mailto:rmartins@redhat.com">rmartins@redhat.com</a>><br>
>>>>>> To: "Vojtech Szocs" <<a href="mailto:vszocs@redhat.com">vszocs@redhat.com</a>><br>
>>>>>> Cc: "Juan Hernández" <<a href="mailto:jhernand@redhat.com">jhernand@redhat.com</a>>, "Michal Skrivanek"<br>
>>>>>> <<a href="mailto:mskrivan@redhat.com">mskrivan@redhat.com</a>>, "devel" <<a href="mailto:devel@ovirt.org">devel@ovirt.org</a>><br>
>>>>>> Sent: Tuesday, January 3, 2017 2:17:49 PM<br>
>>>>>> Subject: Re: [ovirt-devel] Publicly available REST documentation<br>
>>>>>><br>
>>>>>> ----- Original Message -----<br>
>>>>>>> From: "Vojtech Szocs" <<a href="mailto:vszocs@redhat.com">vszocs@redhat.com</a>><br>
>>>>>>> To: "Juan Hernández" <<a href="mailto:jhernand@redhat.com">jhernand@redhat.com</a>><br>
>>>>>>> Cc: "Michal Skrivanek" <<a href="mailto:mskrivan@redhat.com">mskrivan@redhat.com</a>>, "devel" <<a href="mailto:devel@ovirt.org">devel@ovirt.org</a>><br>
>>>>>>> Sent: Tuesday, January 3, 2017 2:11:06 PM<br>
>>>>>>> Subject: Re: [ovirt-devel] Publicly available REST documentation<br>
>>>>>>><br>
>>>>>>><br>
>>>>>>><br>
>>>>>>> ----- Original Message -----<br>
>>>>>>>> From: "Juan Hernández" <<a href="mailto:jhernand@redhat.com">jhernand@redhat.com</a>><br>
>>>>>>>> To: "Jakub Niedermertl" <<a href="mailto:jniederm@redhat.com">jniederm@redhat.com</a>><br>
>>>>>>>> Cc: "devel" <<a href="mailto:devel@ovirt.org">devel@ovirt.org</a>>, "Michal Skrivanek"<br>
>>>>>>>> <<a href="mailto:mskrivan@redhat.com">mskrivan@redhat.com</a>><br>
>>>>>>>> Sent: Monday, January 2, 2017 10:48:53 PM<br>
>>>>>>>> Subject: Re: [ovirt-devel] Publicly available REST documentation<br>
>>>>>>>><br>
>>>>>>>> On 01/02/2017 10:13 PM, Jakub Niedermertl wrote:<br>
>>>>>>>>> Hi Juan,<br>
>>>>>>>>><br>
>>>>>>>>> from time to time I'd like the REST doc to be available on some<br>
>>>>>>>>> public<br>
>>>>>>>>> site. It would allow us to<br>
>>>>>>>>> * check the documentation without searching for running engine<br>
>>>>>>>>> * be able to easily link documentations in irc/mails<br>
>>>>>>>>> * link rest doc from <a href="http://ovirt.org" rel="noreferrer" target="_blank">ovirt.org</a> site doc<br>
>>>>>>>>> Recently I've also heard similar request from other guys (cc-ed).<br>
>>>>>>>>> Would it be possible to for example publish generated doc of merged<br>
>>>>>>>>> patches of ovirt-engine-api-model project? Maybe github project<br>
>>>>>>>>> pages<br>
>>>>>>>>> [1] of project mirror [2] could be used for hosting.<br>
>>>>>>>>><br>
>>>>>>>>> Regards<br>
>>>>>>>>> Jakub<br>
>>>>>>>>><br>
>>>>>>>>> [1]<br>
>>>>>>>>> <a href="https://help.github.com/articles/user-organization-and-project-pages/#project-pages" rel="noreferrer" target="_blank">https://help.github.com/<wbr>articles/user-organization-<wbr>and-project-pages/#project-<wbr>pages</a><br>
>>>>>>>>> [2] <a href="https://github.com/oVirt/ovirt-engine-api-model" rel="noreferrer" target="_blank">https://github.com/oVirt/<wbr>ovirt-engine-api-model</a><br>
>>>>>>>>><br>
>>>>>>>><br>
>>>>>>>> Yes, we can publish the documentation using gh-pages. I just created<br>
>>>>>>>> and<br>
>>>>>>>> populated the 'gh-branch' with some initial content, and requested<br>
>>>>>>>> the<br>
>>>>>>>> activation of the feature in Github. I will inform you when it is<br>
>>>>>>>> ready.<br>
>>>>>>><br>
>>>>>>> Alternatively, you could use <a href="http://readthedocs.org" rel="noreferrer" target="_blank">readthedocs.org</a> which supports webhooks:<br>
>>>>>>> a push to GitHub (mirror) project [syncing Gerrit with GitHub] would<br>
>>>>>>> regenerate the project's documentation available at<br>
>>>>>>><br>
>>>>>>> <your-project>.<a href="http://readthedocs.io" rel="noreferrer" target="_blank">readthedocs.io</a><br>
>>>>>>><br>
>>>>>>> which would allow to separate the GitHub project from its docs, given<br>
>>>>>>> the source comes from Gerrit.<br>
>>>>>><br>
>>>>>> ReadTheDocs relies on sphinx and/or mkdocs to rebuild the docs when<br>
>>>>>> called<br>
>>>>>> by<br>
>>>>>> the webhook, and we use something else. We just need some hosting for<br>
>>>>>> static<br>
>>>>>> files, then github-pages is a better solution.<br>
>>>>><br>
>>>>> Hm, and what about pushing to <a href="https://github.com/oVirt/ovirt-site" rel="noreferrer" target="_blank">https://github.com/oVirt/<wbr>ovirt-site</a> directly,<br>
>>>>> instead of pushing to GitHub (mirror) project pages?<br>
>>>><br>
>>>> there's no real need to mess with the ovirt-site repo. we can have a<br>
>>>> separated repo, that can be freely updated by a jenkins job, for example,<br>
>>>> and include it on ovirt-site using a sub-repository, like it is done for<br>
>>>> data/events today. The good thing of this approach is that we can have<br>
>>>> "unstable" docs in the separated repo, updated by jenkins, and just checkout<br>
>>>> stable versions on the ovirt-site subrepo.<br>
>>><br>
>>> I like the idea of <project-x-docs> as sub-repo of <ovirt-site> :)<br>
>>><br>
>>> Thanks for your response, it makes sense.<br>
>>><br>
>>>><br>
>>>> Rafael<br>
>>>><br>
>>>>>><br>
>>>>>> Thanks.<br>
>>>>>> Rafael<br>
>>>>>><br>
>>>>>>>> ______________________________<wbr>_________________<br>
>>>>>>>> Devel mailing list<br>
>>>>>>>> <a href="mailto:Devel@ovirt.org">Devel@ovirt.org</a><br>
>>>>>>>> <a href="http://lists.ovirt.org/mailman/listinfo/devel" rel="noreferrer" target="_blank">http://lists.ovirt.org/<wbr>mailman/listinfo/devel</a><br>
>>>>>>>><br>
>>>>>>> ______________________________<wbr>_________________<br>
>>>>>>> Devel mailing list<br>
>>>>>>> <a href="mailto:Devel@ovirt.org">Devel@ovirt.org</a><br>
>>>>>>> <a href="http://lists.ovirt.org/mailman/listinfo/devel" rel="noreferrer" target="_blank">http://lists.ovirt.org/<wbr>mailman/listinfo/devel</a><br>
>>>>>><br>
>>>>><br>
>>>><br>
>>> ______________________________<wbr>_________________<br>
>>> Devel mailing list<br>
>>> <a href="mailto:Devel@ovirt.org">Devel@ovirt.org</a><br>
>>> <a href="http://lists.ovirt.org/mailman/listinfo/devel" rel="noreferrer" target="_blank">http://lists.ovirt.org/<wbr>mailman/listinfo/devel</a><br>
><br>
______________________________<wbr>_________________<br>
Devel mailing list<br>
<a href="mailto:Devel@ovirt.org">Devel@ovirt.org</a><br>
<a href="http://lists.ovirt.org/mailman/listinfo/devel" rel="noreferrer" target="_blank">http://lists.ovirt.org/<wbr>mailman/listinfo/devel</a></div></blockquote></div><br></div></div></div>