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

Lana Brindley openstack at lanabrindley.com
Sun Oct 9 22:55:39 UTC 2016


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 <openstack at lanabrindley.com> 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 <jay at jvf.cc <mailto:jay at jvf.cc>> 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-docs at lists.openstack.org <mailto:OpenStack-docs at lists.openstack.org>
>>>    http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs <http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs>
>>>
>>>
>>>
>>>
>>> _______________________________________________
>>> OpenStack-docs mailing list
>>> OpenStack-docs at 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-docs at lists.openstack.org
>> http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs
> 

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

-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 538 bytes
Desc: OpenPGP digital signature
URL: <http://lists.openstack.org/pipermail/openstack-dev/attachments/20161010/e54a321d/attachment.pgp>


More information about the OpenStack-dev mailing list