[JIRA] (OVIRT-1676) Refresh oVirt Gerrit Hooks documentation

24 Oct 2017


      This is a multi-part message in MIME format...

------------=_1508833269-26273-114
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 7bit


     [ https://ovirt-jira.atlassian.net/browse/OVIRT-1676?page=com.atlassian.jira.p... ]

eyal edri reassigned OVIRT-1676:
--------------------------------

    Assignee: Shlomo Ben David  (was: infra)
...
Refresh oVirt Gerrit Hooks documentation 
-----------------------------------------
Key: OVIRT-1676
                URL: https://ovirt-jira.atlassian.net/browse/OVIRT-1676
            Project: oVirt - virtualization made easy
         Issue Type: Task
         Components: Gerrit/git
           Reporter: eyal edri
           Assignee: Shlomo Ben David
           Priority: High
There has been a lot of work done and improvements around the oVirt Gerrit Hooks in the past year, including refactoring of the whole projects, moving to Python, adding new hooks and consolidating libraries.
However, the official documentation for it has remained outdated and doesn't reflect the latest updates.
We need to go over all current docs and refresh it with new updated content ( i.e remove obsolete info and add info on the new stuff ).
The current locations (at least that I'm aware of) that needs updating:
* ovirt.org: https://ovirt.org/develop/infra/gerrit-hooks/ 
   *  I recommend to remove this page and add a link to gerrit-hooks readthedocs page instead
   * However, I would recommend adding a section on it here https://ovirt.org/develop/dev-process/working-with-gerrit/ and mentioning that each project has various hooks that adds automation and verfication.
* oVirt infra RTD: http://ovirt-infra-docs.readthedocs.io/en/latest/CI/Gerrit_Hooks/index.html
  * This needs a refresh and should focus on how to deploy hooks on a project, enable different suites, type of suites, etc..  ( so basically a simple "user guide" or usage guide )
* Gerrit Hooks RTD: http://ovirt-gerrit-hooks.readthedocs.io/en/latest/
   *  This should be completely refactored, as the design and code changed significantly
   *  The first section should be aimed at infra team, explaining the design of the project, deployment on the Gerrit server, steps to deploy new code, and anything admin would need to know about the project
   *  The second section should be auto-generated from the code itself and show the documentation on all the classes and functions.
[~sbendavi@redhat.com][~amarchuk] I think we can take advantage of the quiet time during the shutdown to start focusing on this important task and get some progress.
Let me know if I missed anything.
--
This message was sent by Atlassian Jira
(v1001.0.0-SNAPSHOT#100068)

------------=_1508833269-26273-114
Content-Type: text/html; charset="UTF-8"
Content-Disposition: inline
Content-Transfer-Encoding: 7bit

<html><body>
<pre>[ https://ovirt-jira.atlassian.net/browse/OVIRT-1676?page=com.atlassian.jira.p... ]</pre>
<h3>eyal edri reassigned OVIRT-1676:</h3>
<pre>Assignee: Shlomo Ben David  (was: infra)</pre>
<blockquote><h3>Refresh oVirt Gerrit Hooks documentation</h3>
<pre>     Key: OVIRT-1676
     URL: https://ovirt-jira.atlassian.net/browse/OVIRT-1676
 Project: oVirt - virtualization made easy
         Issue Type: Task
         Components: Gerrit/git
Reporter: eyal edri
Assignee: Shlomo Ben David
Priority: High</pre>
<p>There has been a lot of work done and improvements around the oVirt Gerrit Hooks in the past year, including refactoring of the whole projects, moving to Python, adding new hooks and consolidating libraries. However, the official documentation for it has remained outdated and doesn't reflect the latest updates. We need to go over all current docs and refresh it with new updated content ( i.e remove obsolete info and add info on the new stuff ). The current locations (at least that I'm aware of) that needs updating:</p>
<ul><li><p>ovirt.org: <a href="https://ovirt.org/develop/infra/gerrit-hooks/">https://ovirt.org/develop/infra/gerrit-hooks/</a></p>
<pre>*  I recommend to remove this page and add a link to gerrit-hooks readthedocs page instead
* However, I would recommend adding a section on it here https://ovirt.org/develop/dev-process/working-with-gerrit/ and mentioning that each project has various hooks that adds automation and verfication.</pre></li>
<li><p>oVirt infra RTD: <a href="http://ovirt-infra-docs.readthedocs.io/en/latest/CI/Gerrit_Hooks/index.html">http://ovirt-infra-docs.readthedocs.io/en/latest/CI/Gerrit_Hooks/index.html</a></p>
<ul><li><p>This needs a refresh and should focus on how to deploy hooks on a project, enable different suites, type of suites, etc..  ( so basically a simple “user guide” or usage guide )</p></li></ul></li>
<li><p>Gerrit Hooks RTD: <a href="http://ovirt-gerrit-hooks.readthedocs.io/en/latest/">http://ovirt-gerrit-hooks.readthedocs.io/en/latest/</a></p>
<pre>*  This should be completely refactored, as the design and code changed significantly
*  The first section should be aimed at infra team, explaining the design of the project, deployment on the Gerrit server, steps to deploy new code, and anything admin would need to know about the project
*  The second section should be auto-generated from the code itself and show the documentation on all the classes and functions.</pre></li></ul>
<p>[~sbendavi@redhat.com][~amarchuk] I think we can take advantage of the quiet time during the shutdown to start focusing on this important task and get some progress. Let me know if I missed anything.</p></blockquote>
<p>— This message was sent by Atlassian Jira (v1001.0.0-SNAPSHOT#100068)</p>

<img src="https://u4043402.ct.sendgrid.net/wf/open?upn=i5TMWGV99amJbNxJpSp2-2BCmpYLyzY..." alt="" width="1" height="1" border="0" style="height:1px !important;width:1px !important;border-width:0 !important;margin-top:0 !important;margin-bottom:0 !important;margin-right:0 !important;margin-left:0 !important;padding-top:0 !important;padding-bottom:0 !important;padding-right:0 !important;padding-left:0 !important;"/>
</body></html>

------------=_1508833269-26273-114--

eyal edri (oVirt JIRA)

tags

participants (1)