[openstack-dev] [sahara] Pre-PTG Doc Day

Luigi Toscano ltoscano at redhat.com
Tue Feb 6 15:28:56 UTC 2018


On Tuesday, 6 February 2018 12:53:17 CET Telles Nobrega wrote:
> Hi folks,
> 
> as we discussed in our last meeting, tomorrow (Wednesday 7th) we are going
> to do a first overview of our documentation in order to gather the maximum
> information of where we need to fix, add or remove stuff so we don't waste
> time at PTG on this.
> 
> We can fix small problems but the main goal is to have a list of places
> that need fixing, so we can use during Rocky cycle as a guide for
> documentation improvement.

Of course I think that if we find that something not trivial can be fixed 
anyway, no one is going to complain.

> 
> In order to maiximize our reach it would good to split where each of us
> will be looking at the documentation, so I thought:
> 
> From:
> https://docs.openstack.org/sahara/latest/ we can split in 4 parts, since
> user guide seems to be biggest one person would work on User Guide, and
> other 3 each work on 2 topics (we can choose freely)

I can help with this, but I will start with sahara-tests (see below); during 
the day, if no one else is working on other parts, I will start reading some 
of those other documents.

> 
> From:
> https://docs.openstack.org/sahara-tests/latest/ it seems very direct, maybe
> tosky and I can take a look at it (everyone is free to do so as well)

I will focus on this at first.


> 
> If anyone needs help, or the rabbit hole grows too much we can always
> reorganize the split.
> 
> What do you think of it?

I would say: let's start reading, and maybe we can find that there are some 
topics that can be covered throughout all the documents: reference to 
technologies that are no more valid, or the reference to the pre-built images, 
etc, and fix them first. Let's see.

Ciao
-- 
Luigi





More information about the OpenStack-dev mailing list