Re: [openstack-dev] [OpenStack-docs] Admin guide in-tree?

[Ruby Loo]

>From my point of view, the rush is so that we can be more efficient with
all of our time/efforts. In ironic, we have a bit of a mess. We now have
duplicated (and perhaps out-of-sync) admin-related information in our
developer docs [1] as well as in the official admin guide [2] -- the latter
content was added but I am unaware of that knowledge/coordination being
done with the ironic community :-(

Should we :
A. move our admin-related information from our developer docs to the
existing admin guide; then move the admin guide to the new in-tree solution
later

B. replace what is in the existing admin guide with a pointer to the
developer docs; then move the admin content to the new in-tree solution
later

C. status quo until the new in-tree solution is available

--ruby

[1] http://docs.openstack.org/developer/ironic/
[2] http://docs.openstack.org/admin-guide/baremetal.html


On Mon, Oct 10, 2016 at 7:07 PM, Lana Brindley 
wrote:

> On 10/10/16 16:25, Andreas Jaeger wrote:
> > On 2016-10-10 01:37, Steve Martinelli wrote:
> >> On Oct 9, 2016 6:57 PM, "Lana Brindley"  >> > wrote:
> >>>
> >>> Why the rush?
> >>
> >> I think its more eagerness than rush. Project teams made a lot of head
> >> way with the API ref and install guides being in-tree that they want to
> >> keep the momentum with the admin guide.
> >
> > Those teams are more than welcome to contribute today to the
> > openstack-manuals repository! Is there anything we can help these?
> >
> > Andreas
> >
>
> Yes, Andreas makes a good point. If there's content you want in the guides
> now, we can help you with that.
>
> Lana
>
> --
> Lana Brindley
> Technical Writer
> Rackspace Cloud Builders Australia
> http://lanabrindley.com
>
>
> __
> 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] [OpenStack-docs] Admin guide in-tree?

[Lana Brindley]

On 10/10/16 16:25, Andreas Jaeger wrote:
> On 2016-10-10 01:37, Steve Martinelli wrote:
>> On Oct 9, 2016 6:57 PM, "Lana Brindley" > > wrote:
>>>
>>> Why the rush?
>>
>> I think its more eagerness than rush. Project teams made a lot of head
>> way with the API ref and install guides being in-tree that they want to
>> keep the momentum with the admin guide.
> 
> Those teams are more than welcome to contribute today to the
> openstack-manuals repository! Is there anything we can help these?
> 
> Andreas
> 

Yes, Andreas makes a good point. If there's content you want in the guides now, 
we can help you with that.

Lana

-- 
Lana Brindley
Technical Writer
Rackspace Cloud Builders Australia
http://lanabrindley.com



signature.asc
Description: OpenPGP digital signature
__
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] [OpenStack-docs] Admin guide in-tree?

[Andreas Jaeger]

On 2016-10-10 01:37, Steve Martinelli wrote:
> On Oct 9, 2016 6:57 PM, "Lana Brindley"  > wrote:
>>
>> Why the rush?
> 
> I think its more eagerness than rush. Project teams made a lot of head
> way with the API ref and install guides being in-tree that they want to
> keep the momentum with the admin guide.

Those teams are more than welcome to contribute today to the
openstack-manuals repository! Is there anything we can help these?

Andreas
-- 
 Andreas Jaeger aj@{suse.com,opensuse.org} Twitter: jaegerandi
  SUSE LINUX GmbH, Maxfeldstr. 5, 90409 Nürnberg, Germany
   GF: Felix Imendörffer, Jane Smithard, Graham Norton,
   HRB 21284 (AG Nürnberg)
GPG fingerprint = 93A3 365E CE47 B889 DF7F  FED1 389A 563C C272 A126


__
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] [OpenStack-docs] Admin guide in-tree?

[Lana Brindley]

On 10/10/16 09:37, Steve Martinelli wrote:
> On Oct 9, 2016 6:57 PM, "Lana Brindley"  > wrote:
>>
>> Why the rush?
> 
> I think its more eagerness than rush. Project teams made a lot of head way 
> with the API ref and install guides being in-tree that they want to keep the 
> momentum with the admin guide.
> 

That makes sense, and I really  appreciate the enthusiasm. I'll take these 
concerns to the Summit, and if the docs team decide that we need to take 
advantage of that and push ahead in the Ocata cycle, then I'll go with it.

Lana

-- 
Lana Brindley
Technical Writer
Rackspace Cloud Builders Australia
http://lanabrindley.com



signature.asc
Description: OpenPGP digital signature
__
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] [OpenStack-docs] Admin guide in-tree?

[Steve Martinelli]

On Oct 9, 2016 6:57 PM, "Lana Brindley"  wrote:
>
> Why the rush?

I think its more eagerness than rush. Project teams made a lot of head way
with the API ref and install guides being in-tree that they want to keep
the momentum with the admin guide.
__
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] [OpenStack-docs] Admin guide in-tree?

[Lana Brindley]

Thanks for the offer. The scope of the work is probably not huge, based on what 
we know from the Install Guide. We should be able to more or less copy what we 
did there. However, I want to collect data based on that experience before we 
begin, rather than barrelling on down that road. Additionally, I don't feel as 
though the Install Guide is absolutely complete until we've got the index page 
done. As I said earlier, there is also the consideration of the short release 
cycle for Ocata.

One point I will make, though, that is with a Pike schedule, you would have 
Admin Guides up under this model by the Pike release date (about twelve months 
from now). We planned the Install Guides at the Austin summit, and have 
published them with Newton. 

Why the rush?

Lana

On 08/10/16 02:13, Jay Faulkner wrote:
> I'm not necessarily just asking for it to be done -- I'm curious what the 
> scope of work is because I'm potentially willing to help (and find folks to 
> help) get it done sooner. If the docs team does not support the admin guide 
> in-tree until Pike, It'll be Q or later before other projects can utilize it. 
> That's over a year from today, and I'd rather not have to wait that long to 
> get a better admin guide up for Ironic.
> 
> Thanks,
> Jay Faulkner
> OSIC
> 
>> On Oct 6, 2016, at 8:04 PM, Lana Brindley  wrote:
>>
>> (Adding the dev list to cc, as I think this conversation deserves a wider 
>> audience)
>>
>> Thanks for this feedback. I'm really glad that the new Install Guide model 
>> is working out well for people!
>>
>> Since our new Install Guides have only just been published, at this stage 
>> I'm intending to gather some data on how projects and users are using the 
>> project-specific Install Guides during the next cycle. I'm also intending to 
>> spend some time in the Ocata cycle on improving that index page. It's pretty 
>> ugly right now, and I think there's some  serious UX improvements to be 
>> done. Since Ocata is a short cycle, I'm also conscious of how much the docs 
>> team might realistically be able to achieve.
>>
>> All that said, you are certainly not the first to ask if this model can be 
>> extended! I think it's something that the docs community would like to see, 
>> and it seems as though it has broad support amongst developers and projects 
>> as well. So, in short, I think this is a thing that will happen, but 
>> probably not in Ocata. I'm tentatively willing to tell you that Pike is a 
>> possibility though ;)
>>
>> Lana
>>
>> On 07/10/16 12:43, Steve Martinelli wrote:
>>> FWIW, the keystone team would also be interested in this model
>>>
>>> On Thu, Oct 6, 2016 at 11:40 AM, Jay Faulkner >> > wrote:
>>>
>>>Hi all,
>>>
>>>For those of you who don't know me, I'm Jay Faulkner and I work on 
>>> Ironic as the Docs liaison as one of my hats.
>>>
>>>Ironic launched our install-guide right after newton closed, and 
>>> backported it, thanks to the changes to make the install-guide available in 
>>> tree. We're a huge fan of this model, and I'm curious if there's any plans 
>>> to make this happen for the admin-guide. If not, can someone help me 
>>> understand the scope of work, presuming it's something that the docs group 
>>> is interested in.
>>>
>>>If we can get the technical infrastructure in place to do admin-guide in 
>>> tree, I'd expect Ironic to quickly adopt it, like we did for the install 
>>> guide.
>>>
>>>Thanks,
>>>Jay Faulkner
>>>OSIC
>>>
>>>
>>>___
>>>OpenStack-docs mailing list
>>>openstack-d...@lists.openstack.org 
>>> 
>>>http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs 
>>> 
>>>
>>>
>>>
>>>
>>> ___
>>> OpenStack-docs mailing list
>>> openstack-d...@lists.openstack.org
>>> http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs
>>>
>>
>> --
>> Lana Brindley
>> Technical Writer
>> Rackspace Cloud Builders Australia
>> http://lanabrindley.com
>>
>> ___
>> OpenStack-docs mailing list
>> openstack-d...@lists.openstack.org
>> http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs
> 

-- 
Lana Brindley
Technical Writer
Rackspace Cloud Builders Australia
http://lanabrindley.com



signature.asc
Description: OpenPGP digital signature
__
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] [OpenStack-docs] Admin guide in-tree?

[Jay Faulkner]

I'm not necessarily just asking for it to be done -- I'm curious what the scope 
of work is because I'm potentially willing to help (and find folks to help) get 
it done sooner. If the docs team does not support the admin guide in-tree until 
Pike, It'll be Q or later before other projects can utilize it. That's over a 
year from today, and I'd rather not have to wait that long to get a better 
admin guide up for Ironic.

Thanks,
Jay Faulkner
OSIC

> On Oct 6, 2016, at 8:04 PM, Lana Brindley  wrote:
> 
> (Adding the dev list to cc, as I think this conversation deserves a wider 
> audience)
> 
> Thanks for this feedback. I'm really glad that the new Install Guide model is 
> working out well for people!
> 
> Since our new Install Guides have only just been published, at this stage I'm 
> intending to gather some data on how projects and users are using the 
> project-specific Install Guides during the next cycle. I'm also intending to 
> spend some time in the Ocata cycle on improving that index page. It's pretty 
> ugly right now, and I think there's some  serious UX improvements to be done. 
> Since Ocata is a short cycle, I'm also conscious of how much the docs team 
> might realistically be able to achieve.
> 
> All that said, you are certainly not the first to ask if this model can be 
> extended! I think it's something that the docs community would like to see, 
> and it seems as though it has broad support amongst developers and projects 
> as well. So, in short, I think this is a thing that will happen, but probably 
> not in Ocata. I'm tentatively willing to tell you that Pike is a possibility 
> though ;)
> 
> Lana
> 
> On 07/10/16 12:43, Steve Martinelli wrote:
>> FWIW, the keystone team would also be interested in this model
>> 
>> On Thu, Oct 6, 2016 at 11:40 AM, Jay Faulkner > > wrote:
>> 
>>Hi all,
>> 
>>For those of you who don't know me, I'm Jay Faulkner and I work on Ironic 
>> as the Docs liaison as one of my hats.
>> 
>>Ironic launched our install-guide right after newton closed, and 
>> backported it, thanks to the changes to make the install-guide available in 
>> tree. We're a huge fan of this model, and I'm curious if there's any plans 
>> to make this happen for the admin-guide. If not, can someone help me 
>> understand the scope of work, presuming it's something that the docs group 
>> is interested in.
>> 
>>If we can get the technical infrastructure in place to do admin-guide in 
>> tree, I'd expect Ironic to quickly adopt it, like we did for the install 
>> guide.
>> 
>>Thanks,
>>Jay Faulkner
>>OSIC
>> 
>> 
>>___
>>OpenStack-docs mailing list
>>openstack-d...@lists.openstack.org 
>> 
>>http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs 
>> 
>> 
>> 
>> 
>> 
>> ___
>> OpenStack-docs mailing list
>> openstack-d...@lists.openstack.org
>> http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs
>> 
> 
> --
> Lana Brindley
> Technical Writer
> Rackspace Cloud Builders Australia
> http://lanabrindley.com
> 
> ___
> OpenStack-docs mailing list
> openstack-d...@lists.openstack.org
> http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs



signature.asc
Description: Message signed with OpenPGP using GPGMail
__
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] [OpenStack-docs] Admin guide in-tree?

[Lana Brindley]

(Adding the dev list to cc, as I think this conversation deserves a wider 
audience)

Thanks for this feedback. I'm really glad that the new Install Guide model is 
working out well for people!

Since our new Install Guides have only just been published, at this stage I'm 
intending to gather some data on how projects and users are using the 
project-specific Install Guides during the next cycle. I'm also intending to 
spend some time in the Ocata cycle on improving that index page. It's pretty 
ugly right now, and I think there's some  serious UX improvements to be done. 
Since Ocata is a short cycle, I'm also conscious of how much the docs team 
might realistically be able to achieve.

All that said, you are certainly not the first to ask if this model can be 
extended! I think it's something that the docs community would like to see, and 
it seems as though it has broad support amongst developers and projects as 
well. So, in short, I think this is a thing that will happen, but probably not 
in Ocata. I'm tentatively willing to tell you that Pike is a possibility though 
;)

Lana

On 07/10/16 12:43, Steve Martinelli wrote:
> FWIW, the keystone team would also be interested in this model
> 
> On Thu, Oct 6, 2016 at 11:40 AM, Jay Faulkner  > wrote:
> 
> Hi all,
> 
> For those of you who don't know me, I'm Jay Faulkner and I work on Ironic 
> as the Docs liaison as one of my hats.
> 
> Ironic launched our install-guide right after newton closed, and 
> backported it, thanks to the changes to make the install-guide available in 
> tree. We're a huge fan of this model, and I'm curious if there's any plans to 
> make this happen for the admin-guide. If not, can someone help me understand 
> the scope of work, presuming it's something that the docs group is interested 
> in.
> 
> If we can get the technical infrastructure in place to do admin-guide in 
> tree, I'd expect Ironic to quickly adopt it, like we did for the install 
> guide.
> 
> Thanks,
> Jay Faulkner
> OSIC
> 
> 
> ___
> OpenStack-docs mailing list
> openstack-d...@lists.openstack.org 
> 
> http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs 
> 
> 
> 
> 
> 
> ___
> OpenStack-docs mailing list
> openstack-d...@lists.openstack.org
> http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs
> 

-- 
Lana Brindley
Technical Writer
Rackspace Cloud Builders Australia
http://lanabrindley.com



signature.asc
Description: OpenPGP digital signature
__
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