[JIRA] (OVIRT-1707) The infra docs index page needs a face lift

Tuesday, 17 October 2017

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

------------=_1508233258-13963-275
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 7bit

Barak Korren created OVIRT-1707:
-----------------------------------

             Summary: 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

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#100066)

------------=_1508233258-13963-275
Content-Type: text/html; charset="UTF-8"
Content-Disposition: inline
Content-Transfer-Encoding: 7bit

<html><body>
<h3>Barak Korren created OVIRT-1707:</h3>
<pre>   Summary: 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</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
&ldquo;Communication&rdquo; should probably be &ldquo;Communicating with the
oVirt infra team&rdquo;. # 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 &ldquo;general&rdquo; section is just a
random collection of things. It should probably be split apart into more specific sections
like &ldquo;Gerrit&rdquo;, &ldquo;Contribution guidelines&rdquo; and
&ldquo;Procedures for infra-team members&rdquo;.</p>
<p>&mdash; This message was sent by Atlassian Jira
(v1001.0.0-SNAPSHOT#100066)</p>

------------=_1508233258-13963-275--

2024

2023

2022

2021

2020

2019

2018

2017

2016

2015

2014

2013

2012

2011