[OpenStack-docs] [install-guide] Mimicking the install-guide for project specific install guides

Lana Brindley openstack at lanabrindley.com
Tue Jul 5 03:45:30 UTC 2016


On 04/07/16 15:57, Andreas Jaeger wrote:
> On 07/04/2016 07:33 AM, Lana Brindley wrote:
>> On 04/07/16 15:23, Andreas Jaeger wrote:
>>> On 07/04/2016 03:44 AM, Lana Brindley wrote:
>>>> Sorry for being late to the party. Right now, I think I don't fully understand all the issues, which is why I've been holding off. However, I think rolling with option 3 (let projects choose for now and revisit) seems sensible for the moment. I don't think it's wise to mandate (or ban) use of only at this early stage until we have a clearer picture of how it's being used (or abused).
>>>
>>> It's not use or abuse - it's far more complicated to use (both on
>>> tooling and reviewing) as well more difficult to generate a proper index.
>>>
>>> We've had quite some fun getting only right in our guides and still
>>> every now and then a change comes in that is supposed for one distro but
>>> breaks others. We now have some reviewers that know what to look for and
>>> how to review this - but this is a complexity that needs teaching to
>>> core reviewers in those project teams.
>>>
>>> Also, building with only means you have to build for each distro -
>>> that's a more difficult way of setting it up (needs extra scripts) as
>>> well you need to be careful with publishing so that we can use the same
>>> jobs for all projects.
>>>
>>
>> Thanks for the explanation, that's making more sense now. I still think that letting projects do what they want for now and reviewing later seems sensible, I think we need to gauge what's more broadly useful. I can see how banning only can make things easier for us, but I also think there's projects that might need it.
> 
> They ask here for guideance as well and my strong recommendation is to
> not use only.
> 
> Note that we have a single cookiecutter that uses the non-only version
> currently. Also, our documentation currently does not speak about only.
> 
> Our draft index page is not ready and I'm curious how that will look
> like with both variants.
> 
> I don't have the bandwidth right now to help project teams with an only
> setup. Is anybody up to help the project teams in case of problems and
> questions?
> 
> Lana, yes, we need to bring the pieces together and refine how we go
> there. So, we might say in half a year: Everybody use only, or nobody
> should use it. Right now, after reviewing changes that were proposed and
> completely broken due to only usage, I have a strong recommendation.
> Lana, your call on which way to experiment and then help the teams move
> forward,

I'm going to bring this up at the Install Guide team meeting later today (0600 UTC), and will come back with a recommendation based on that conversation.

Lana

-- 
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-docs/attachments/20160705/bcb856c8/attachment.pgp>


More information about the OpenStack-docs mailing list