Re: [openstack-dev] [docs] Style guide for OpenStack documentation

2018-05-28 Thread Jeremy Stanley
On 2018-05-28 16:40:13 +0200 (+0200), Petr Kovar wrote: [...] > I'm all for openness but maintaining consistency is why style guides > matter. Switching to a different style guide would require the following: > > 1) agreeing on the right style guide, > 2) reviewing our current style guidelines in

Re: [openstack-dev] [docs] Style guide for OpenStack documentation

2018-05-28 Thread Stefano Canepa
On 28 May 2018 at 15:40, Petr Kovar wrote: > On Thu, 17 May 2018 15:03:23 + > Jeremy Stanley wrote: > > > On 2018-05-17 16:35:36 +0200 (+0200), Petr Kovar wrote: > ​%<- ​ > I'm all for openness but maintaining consistency is why style guides >

Re: [openstack-dev] [docs] Style guide for OpenStack documentation

2018-05-28 Thread Petr Kovar
On Thu, 17 May 2018 15:03:23 + Jeremy Stanley wrote: > On 2018-05-17 16:35:36 +0200 (+0200), Petr Kovar wrote: > > On Wed, 16 May 2018 17:05:15 + > > Jeremy Stanley wrote: > > > > > On 2018-05-16 18:24:45 +0200 (+0200), Petr Kovar wrote: > > >

Re: [openstack-dev] [docs] Style guide for OpenStack documentation

2018-05-17 Thread Jeremy Stanley
On 2018-05-17 16:35:36 +0200 (+0200), Petr Kovar wrote: > On Wed, 16 May 2018 17:05:15 + > Jeremy Stanley wrote: > > > On 2018-05-16 18:24:45 +0200 (+0200), Petr Kovar wrote: > > [...] > > > I'd like to propose replacing the reference to the IBM Style Guide > > > with a

Re: [openstack-dev] [docs] Style guide for OpenStack documentation

2018-05-17 Thread Petr Kovar
On Wed, 16 May 2018 17:05:15 + Jeremy Stanley wrote: > On 2018-05-16 18:24:45 +0200 (+0200), Petr Kovar wrote: > [...] > > I'd like to propose replacing the reference to the IBM Style Guide > > with a reference to the developerWorks editorial style guide > >

Re: [openstack-dev] [docs] Style guide for OpenStack documentation

2018-05-16 Thread Jeremy Stanley
On 2018-05-16 18:24:45 +0200 (+0200), Petr Kovar wrote: [...] > I'd like to propose replacing the reference to the IBM Style Guide > with a reference to the developerWorks editorial style guide > (https://www.ibm.com/developerworks/library/styleguidelines/). > This lightweight version comes from

[openstack-dev] [docs] Style guide for OpenStack documentation

2018-05-16 Thread Petr Kovar
Hi all, For OpenStack documentation contributors, we provide a basic style guide that describes most important guidelines for writing, user interface guidelines, and RST conventions: https://docs.openstack.org/doc-contrib-guide/writing-style.html