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

Barak Korren (oVirt JIRA) jira at ovirt-jira.atlassian.net
Tue Jan 23 12:55:22 UTC 2018


     [ https://ovirt-jira.atlassian.net/browse/OVIRT-1707?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

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)
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.ovirt.org/pipermail/infra/attachments/20180123/fba8d345/attachment-0001.html>


More information about the Infra mailing list