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

2018-02-06 Thread Jeremy Freudberg 
On Tue, Feb 6, 2018 at 10:45 AM, Telles Nobrega  wrote:
>
>
> On Tue, Feb 6, 2018 at 12:37 PM Jeremy Freudberg  
> wrote:
>>
>> On Tue, Feb 6, 2018 at 6:53 AM, 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.
>>
>> +1
>>
>> >
>> > 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.
>> >
>> > 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)
>> >
>> > 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)
>>
>> There's the saharaclient docs as well - but they are quite short and I
>> already read through most of them when I was working on the APIv2
>> stuff. So I'll take the client docs, plus whatever other section in
>> the main doc that you want to assign me :)
>>
>> >
>> > If anyone needs help, or the rabbit hole grows too much we can always
>> > reorganize the split.
>> >
>> > What do you think of it?
>>
>> Good plan. Although we should define our focus a bit better. Are we
>> just trying to find outdated/incorrect stuff, or should we also be
>> trying to look at the big picture? By big picture I mean trying to
>> identify gaps, or thinking about organization and not just content.
>
>
>
> I don't believe this totally up to me, what do you think? I would say lets 
> consider both cases, but work mainly on the outdated/incorrect stuff and at 
> PTG/after we can work in more details on the big picture stuff.

That plan makes sense to me.

>>
>> >
>> > Thanks
>> >
>> >
>> >
>> >
>> > --
>> >
>> > TELLES NOBREGA
>> >
>> > SOFTWARE ENGINEER
>> >
>> > Red Hat Brasil
>> >
>> > Av. Brg. Faria Lima, 3900 - 8º andar - Itaim Bibi, São Paulo
>> >
>> > tenob...@redhat.com
>> >
>> > TRIED. TESTED. TRUSTED.
>> >  Red Hat é reconhecida entre as melhores empresas para trabalhar no Brasil
>> > pelo Great Place to Work.
>> >
>> > __
>> > OpenStack Development Mailing List (not for usage questions)
>> > Unsubscribe: openstack-dev-requ...@lists.openstack.org?subject:unsubscribe
>> > http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev
>> >
>>
>> __
>> OpenStack Development Mailing List (not for usage questions)
>> Unsubscribe: openstack-dev-requ...@lists.openstack.org?subject:unsubscribe
>> http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev
>
> --
>
> TELLES NOBREGA
>
> SOFTWARE ENGINEER
>
> Red Hat Brasil
>
> Av. Brg. Faria Lima, 3900 - 8º andar - Itaim Bibi, São Paulo
>
> tenob...@redhat.com
>
> TRIED. TESTED. TRUSTED.
>  Red Hat é reconhecida entre as melhores empresas para trabalhar no Brasil 
> pelo Great Place to Work.
>
> __
> OpenStack Development Mailing List (not for usage questions)
> Unsubscribe: openstack-dev-requ...@lists.openstack.org?subject:unsubscribe
> http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev
>

__
OpenStack Development Mailing List (not for usage questions)
Unsubscribe: openstack-dev-requ...@lists.openstack.org?subject:unsubscribe
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev

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

2018-02-06 Thread Telles Nobrega 
On Tue, Feb 6, 2018 at 12:37 PM Jeremy Freudberg 
wrote:

> On Tue, Feb 6, 2018 at 6:53 AM, 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.
>
> +1
>
> >
> > 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.
> >
> > 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)
> >
> > 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)
>
> There's the saharaclient docs as well - but they are quite short and I
> already read through most of them when I was working on the APIv2
> stuff. So I'll take the client docs, plus whatever other section in
> the main doc that you want to assign me :)
>
> >
> > If anyone needs help, or the rabbit hole grows too much we can always
> > reorganize the split.
> >
> > What do you think of it?
>
> Good plan. Although we should define our focus a bit better. Are we
> just trying to find outdated/incorrect stuff, or should we also be
> trying to look at the big picture? By big picture I mean trying to
> identify gaps, or thinking about organization and not just content.
>


I don't believe this totally up to me, what do you think? I would say lets
consider both cases, but work mainly on the outdated/incorrect stuff and at
PTG/after we can work in more details on the big picture stuff.

> >
> > Thanks
> >
> >
> >
> >
> > --
> >
> > TELLES NOBREGA
> >
> > SOFTWARE ENGINEER
> >
> > Red Hat Brasil
> >
> > Av. Brg. Faria Lima, 3900 - 8º andar - Itaim Bibi, São Paulo
> >
> > tenob...@redhat.com
> >
> > TRIED. TESTED. TRUSTED.
> >  Red Hat é reconhecida entre as melhores empresas para trabalhar no
> Brasil
> > pelo Great Place to Work.
> >
> >
> __
> > OpenStack Development Mailing List (not for usage questions)
> > Unsubscribe:
> openstack-dev-requ...@lists.openstack.org?subject:unsubscribe
> > http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev
> >
>
> __
> OpenStack Development Mailing List (not for usage questions)
> Unsubscribe: openstack-dev-requ...@lists.openstack.org?subject:unsubscribe
> http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev
>
-- 

TELLES NOBREGA

SOFTWARE ENGINEER

Red Hat Brasil  

Av. Brg. Faria Lima, 3900 - 8º andar - Itaim Bibi, São Paulo

tenob...@redhat.com

TRIED. TESTED. TRUSTED. 
 Red Hat é reconhecida entre as melhores empresas para trabalhar no Brasil
pelo Great Place to Work.
__
OpenStack Development Mailing List (not for usage questions)
Unsubscribe: openstack-dev-requ...@lists.openstack.org?subject:unsubscribe
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev

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

2018-02-06 Thread Jeremy Freudberg 
On Tue, Feb 6, 2018 at 6:53 AM, 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.

+1

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

There's the saharaclient docs as well - but they are quite short and I
already read through most of them when I was working on the APIv2
stuff. So I'll take the client docs, plus whatever other section in
the main doc that you want to assign me :)

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

Good plan. Although we should define our focus a bit better. Are we
just trying to find outdated/incorrect stuff, or should we also be
trying to look at the big picture? By big picture I mean trying to
identify gaps, or thinking about organization and not just content.
>
> Thanks
>
>
>
>
> --
>
> TELLES NOBREGA
>
> SOFTWARE ENGINEER
>
> Red Hat Brasil
>
> Av. Brg. Faria Lima, 3900 - 8º andar - Itaim Bibi, São Paulo
>
> tenob...@redhat.com
>
> TRIED. TESTED. TRUSTED.
>  Red Hat é reconhecida entre as melhores empresas para trabalhar no Brasil
> pelo Great Place to Work.
>
> __
> OpenStack Development Mailing List (not for usage questions)
> Unsubscribe: openstack-dev-requ...@lists.openstack.org?subject:unsubscribe
> http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev
>

__
OpenStack Development Mailing List (not for usage questions)
Unsubscribe: openstack-dev-requ...@lists.openstack.org?subject:unsubscribe
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev

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

2018-02-06 Thread Telles Nobrega 
Sounds great Luigi, thanks

On Tue, Feb 6, 2018 at 12:31 PM Luigi Toscano  wrote:

> 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
>
>
>
> __
> OpenStack Development Mailing List (not for usage questions)
> Unsubscribe: openstack-dev-requ...@lists.openstack.org?subject:unsubscribe
> http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev
>
-- 

TELLES NOBREGA

SOFTWARE ENGINEER

Red Hat Brasil  

Av. Brg. Faria Lima, 3900 - 8º andar - Itaim Bibi, São Paulo

tenob...@redhat.com

TRIED. TESTED. TRUSTED. 
 Red Hat é reconhecida entre as melhores empresas para trabalhar no Brasil
pelo Great Place to Work.
__
OpenStack Development Mailing List (not for usage questions)
Unsubscribe: openstack-dev-requ...@lists.openstack.org?subject:unsubscribe
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev

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

2018-02-06 Thread Luigi Toscano 
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



__
OpenStack Development Mailing List (not for usage questions)
Unsubscribe: openstack-dev-requ...@lists.openstack.org?subject:unsubscribe
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev

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

2018-02-06 Thread Telles Nobrega 
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.

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)

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)

If anyone needs help, or the rabbit hole grows too much we can always
reorganize the split.

What do you think of it?

Thanks




-- 

TELLES NOBREGA

SOFTWARE ENGINEER

Red Hat Brasil  

Av. Brg. Faria Lima, 3900 - 8º andar - Itaim Bibi, São Paulo

tenob...@redhat.com

TRIED. TESTED. TRUSTED. 
 Red Hat é reconhecida entre as melhores empresas para trabalhar no Brasil
pelo Great Place to Work.
__
OpenStack Development Mailing List (not for usage questions)
Unsubscribe: openstack-dev-requ...@lists.openstack.org?subject:unsubscribe
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev