The infra docs index page needs a face lift

Description

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:

  1. The page title was probably auto-generated by GitHub and looks wrong

  2. 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.

  3. Some links have opaque non-descriptive text. For example "Communication" should probably be "Communicating with the oVirt infra team".

  4. 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

  5. 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".

Activity

Show:
Evgheni Dereveanchin
April 9, 2020, 4:26 PM

We’ve discussed some other possible improvements on today’s meeting, specifically - adding operating procedures for routine tasks, such as:

  1. add a person to whitelist (explicit steps with examples)

  2. add person to oVirt GitHub org

  3. onboard GitHub project to CI

  4. create a repository mirror

etc

 

Krapali Rai
April 9, 2020, 5:24 PM

Hi ,

I will do it. Thanks for putting that information here.

Evgheni Dereveanchin
6 days ago

Did we merge the patch? Can this be closed?

Assignee

Krapali Rai

Reporter

Barak Korren

Blocked By

None

Components

Priority

High
Configure