[OpenStack-docs] Admin Guide versioning

Ildikó Váncsa ildiko.vancsa at ericsson.com
Fri May 29 11:31:17 UTC 2015


Hi Lana,

To be honest, I would rather keep the content in the Admin Guide in a less versioned way than move it to a place where it does not belong to. I have some further questions just to see the big picture.

How many releases should these guides, like the admin guide cover? I mean is there a window for the content, like last 2-3 stable releases? Or these will be updated with the new changes only in each release?

Thanks,
Ildikó

-----Original Message-----
From: Lana Brindley [mailto:openstack at lanabrindley.com] 
Sent: May 28, 2015 03:07
To: Ildikó Váncsa
Cc: openstack-docs at lists.openstack.org
Subject: Re: Admin Guide versioning

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

Generally, it's as simple as writing "in the [release name] release ..."
(or similar). It seems to me as though that's what the Ceilometer content is currently doing, though.

To be frank, it seems as though versioning is not an issue for the rest of the book, and I'm hesitant to change the whole book to suit ceilometer. I think we need to consider either moving this content elsewhere (that *is* versioned), or moving it into the /developer repo so that it can be updated and maintained there.

What do others think?

Lana

On 27/05/15 18:19, Ildikó Váncsa wrote:
> Hi Lana,
> 
> I wouldn't move the content to the Config Reference just because it is versioned. I think that all the architectural description of Ceilometer and also the list of collected meters belong to the Admin Guide as opposed to the Config Reference.
> 
> How other components handle the situation that the Admin Guide is on master, but the information that is needed is one or two releases behind? I mean that in deployments usually older releases are used as opposed to trunk or latest stable.
> 
> Best Regards,
> Ildikó
> 
> -----Original Message-----
> From: Lana Brindley [mailto:openstack at lanabrindley.com]
> Sent: May 26, 2015 23:45
> To: Ildikó Váncsa
> Cc: openstack-docs at lists.openstack.org
> Subject: Re: Admin Guide versioning
> 
> On 26/05/15 20:44, Ildikó Váncsa wrote:
>> Hi Lana,
> 
>> As we discussed on the summit I reported a bug for the issue 
>> mentioned in the subject:
>> https://bugs.launchpad.net/openstack-manuals/+bug/1458820
> 
>> I think it would be better to maintain stable versions for this guide too like what we have for the Config Reference or the Install Guide. What is your opinion?
> 
> 
> Hi Ildikó,
> 
> Would it better if we just moved the Ceilometer content into the Config Reference instead?
> 
> L
> 
> 

- --
Lana Brindley
Technical Writer
Rackspace Cloud Builders Australia
http://lanabrindley.com
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1

iQEcBAEBAgAGBQJVZmodAAoJELppzVb4+KUy3tMIAI+D+Dhwx+d/cFDq0BLOSz8j
tzc3eC4V4gAfTJHqRGQDjAqkHJHXWI5LFAwJkVcW2nApPdKZhyz/zj55vPnGLyZ3
h1vGo0v8xWun5VHw0mksVzWg4tKMR0oKKP8mG+RfQAsJUzbxpQSMQdSKx3LLJRUM
11LriIiVZTF9xYt++fzUqfR+eUozR8rZ719vRc06AyiREdSXm+RdtmEwjm1ursHA
Dc+koREuZqbgB3gPBMmflntLgkFJb8h2QMMNdriNjkrqU0I23SrgWs9e+AaNr6uw
cYPW//cSjSgZc5xTM26lKX1AMYTmLd7dfral4Vy/SXW0xtMKfCe09dwKbm7fmXI=
=YRqy
-----END PGP SIGNATURE-----


More information about the OpenStack-docs mailing list