openstack-doc-core team mailing list archive

[Steve Gordon <sgordon@xxxxxxxxxx>]

----- Original Message -----
> From: "Andreas Jaeger" <aj@xxxxxxxx>
> To: "Lana Brindley" <openstack@xxxxxxxxxxxxxxxx>, openstack-doc-core@xxxxxxxxxxxxxxxxxxx
> 
> On 06/25/2015 02:16 AM, Lana Brindley wrote:
> > -----BEGIN PGP SIGNED MESSAGE-----
> > Hash: SHA1
> >
> > Hi everyone,
> >
> > First of all, I'm sorry that the Ironic docs thing has turned into a bit
> > of a disaster. I had no idea that we were going to end up in a standards
> > argument over this, but I'm still hopeful that we can see a path through
> > this.
> >
> > The problem: A number of patches (mostly created by Shilla, if I'm not
> > mistaken) are now being blocked in the Ironic repo by an Ironic core who
> > doesn't agree with our standards. While they're certainly entitled to
> > question our standards, blocking the patches means that other good work
> > is not getting merged.
> >
> > The solution: I'm not certain. Right now, what I want to do is send
> > email to Devananda (the Ironic PTL) with a list of the patches being
> > blocked, so we can determine if there's a way we can appease the Ironic
> > core team's concerns over standards. Shilla (and others who have a patch
> > out on this), can you please send me a list of the patches currently
> > being blocked?
> >
> > The fallout: We're already arguing about the standard in question on our
> > own list, and the community seems deeply divided. I personally don't
> > care about the capitalisation of service names, and am happy to enforce
> > whatever the community decides. That said, I feel as though the
> > community is unlikely to come to a solid conclusion on this. Do cores
> > have an opinion? If there is a strong tendency amongst this group,
> > perhaps it's easier to just go with that and adjust accordingly. Please
> > feel free to debate this topic on this thread.
> 
> So, this is "Ironic" vs "ironic"?
> 
> I think what needs to be worked out with a project is that our
> conventions are enforced if we work together. Like there are hacking
> rules for code which a core team reviews, there are documentation rules
> that are under the Documentation team (btw. going to a reviewed style
> guide would help with the story;)!
> 
> On the Ironic vs ironic: While I prefer the lower-case, I see upper-case
> everywhere.
> 
> It's the number one change that I request during reviews.
> 
> If we want to enforce our documentation style everywhere, it might be
> better to not enforce the capitalization or change the rule.
> 
> 
> So, I'm willing to change my vote if that is needed to adopt the Doc
> style everywhere ;)
> 
> Anne, is the Doc style adoption a TC discussion?
> 
> What do we need to make our style guide better consumable by other projects?
> 
> Andreas

This is the patch in question:

    https://review.openstack.org/#/c/194230/1/reference/projects.yaml

It's about Bare metal service versus Bare Metal service.

-Steve