[OpenStack-docs] Reviewed page for Conventions and Style guide?

Andreas Jaeger aj at suse.com
Sun Nov 9 06:49:57 UTC 2014


On 11/08/2014 10:40 PM, Anne Gentle wrote:
> My first thought is move off the wiki sends a message that a deliverable is a style guide and I'm not at all ready for that shift. There are way too many docs to deliver. 

If we move the documentation to the projects for scale-out, we need IMHO
a cross-project style guide - like hacking is today for python style.
This would be part of the "meta-documentation" we spoke about.

> Let me think about it but I had an immediate gut reaction I had to share. It was "blerg!" :)

;)

No need to rush this - I split these emails up on purpose to give us
time to think them through properly...

Andreas

> Anne Gentle
> Content Stacker
> anne at openstack.org
> 
> 
>> On Nov 8, 2014, at 1:27 PM, Andreas Jaeger <aj at suse.com> wrote:
>>
>> Discussing the style guide with the infra-team, Jim Blair suggested to
>> move the content from the wiki to a permanent place - like the infra
>> team moves content from the wiki to infra-manuals.
>>
>> We could place the content in openstack-manuals and publish from there.
>> This would give us the advantage of a reviewed content and record of
>> changes.
>>
>> The infra team also offered infra-manuals as place for it.
>>
>> So, let's discuss this: What do you think of moving?
>> * Should we move the style guide to a git repository?
>> * If yes, which one (openstack-manual, infra-manuals, or any other
>> proposal)?
>> * If yes, which format (Docbook or RST)?
>>
>> Andreas
>> -- 
>> Andreas Jaeger aj@{suse.com,opensuse.org} Twitter/Identica: jaegerandi
>>  SUSE LINUX GmbH, Maxfeldstr. 5, 90409 Nürnberg, Germany
>>   GF:Jeff Hawn,Jennifer Guild,Felix Imendörffer,HRB 21284 (AG Nürnberg)
>>    GPG fingerprint = 93A3 365E CE47 B889 DF7F  FED1 389A 563C C272 A126
>>
>> _______________________________________________
>> OpenStack-docs mailing list
>> OpenStack-docs at lists.openstack.org
>> http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs
> 


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



More information about the OpenStack-docs mailing list