[JIRA] (OVIRT-1707) The infra docs index page needs a face lift
This is a multi-part message in MIME format... ------------=_1516712122-23419-360 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 7bit [ https://ovirt-jira.atlassian.net/browse/OVIRT-1707?page=com.atlassian.jira.p... ] Barak Korren updated OVIRT-1707: -------------------------------- Labels: documentation first_time_task (was: documentation)
The infra docs index page needs a face lift -------------------------------------------
Key: OVIRT-1707 URL: https://ovirt-jira.atlassian.net/browse/OVIRT-1707 Project: oVirt - virtualization made easy Issue Type: Improvement Components: General Reporter: Barak Korren Assignee: infra Priority: High Labels: documentation, first_time_task
The infra-docs index page is the first page about the oVirt infra team that anyone will see, but it looks bad. Here are a few issues with it: # The page title was probably auto-generated by GitHub and looks wrong # The page contains no text. There needs to be some short 2-3 line explanation about what is this page and what could be found in it. The sub sections should probably also include 1-2 lines each about which documents can be found in them. # Some links have opaque non-descriptive text. For example "Communication" should probably be "Communicating with the oVirt infra team". # The documents and sections are listed in semi-random order. Instead, they should be ordered in such a way that the more important public-facing documents are closer to the top # The "general" section is just a random collection of things. It should probably be split apart into more specific sections like "Gerrit", "Contribution guidelines" and "Procedures for infra-team members".
-- This message was sent by Atlassian Jira (v1001.0.0-SNAPSHOT#100076) ------------=_1516712122-23419-360 Content-Type: text/html; charset="UTF-8" Content-Disposition: inline Content-Transfer-Encoding: 7bit <html><body> <pre>[ https://ovirt-jira.atlassian.net/browse/OVIRT-1707?page=com.atlassian.jira.p... ]</pre> <h3>Barak Korren updated OVIRT-1707:</h3> <pre>Labels: documentation first_time_task (was: documentation)</pre> <blockquote><h3>The infra docs index page needs a face lift</h3> <pre> Key: OVIRT-1707 URL: https://ovirt-jira.atlassian.net/browse/OVIRT-1707 Project: oVirt - virtualization made easy Issue Type: Improvement Components: General Reporter: Barak Korren Assignee: infra Priority: High Labels: documentation, first_time_task</pre> <p>The infra-docs index page is the first page about the oVirt infra team that anyone will see, but it looks bad. Here are a few issues with it: # The page title was probably auto-generated by GitHub and looks wrong # The page contains no text. There needs to be some short 2-3 line explanation about what is this page and what could be found in it. The sub sections should probably also include 1-2 lines each about which documents can be found in them. # Some links have opaque non-descriptive text. For example “Communication” should probably be “Communicating with the oVirt infra team”. # The documents and sections are listed in semi-random order. Instead, they should be ordered in such a way that the more important public-facing documents are closer to the top # The “general” section is just a random collection of things. It should probably be split apart into more specific sections like “Gerrit”, “Contribution guidelines” and “Procedures for infra-team members”.</p></blockquote> <p>— This message was sent by Atlassian Jira (v1001.0.0-SNAPSHOT#100076)</p> <img src="https://u4043402.ct.sendgrid.net/wf/open?upn=i5TMWGV99amJbNxJpSp2-2BJ33BSM3t..." 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> ------------=_1516712122-23419-360--
participants (1)
-
Barak Korren (oVirt JIRA)