docs icon indicating copy to clipboard operation
docs copied to clipboard

Add YAML naming/case guidelines to style guide

Open plumbis opened this issue 2 years ago • 1 comments

What's Missing?

The docs style guide should add content on proper styling for Kubernetes YAML definitions likekinds and names.

The Kube docs is a good starting point https://kubernetes.io/docs/contribute/style/style-guide/#documentation-formatting-standards

This was called out in f821153 (#326)

plumbis avatar Feb 02 '23 16:02 plumbis

I think there's almost two things here:

  • A style guide for writing things like CompositeResourceDefinition outside of example manifests.
  • What is valid and idiomatic inside example manifests.

I like that Kubernetes style guide for the former. There's also a lot of Crossplane-specific advice on style in https://docs.crossplane.io/v1.11/concepts/terminology/.

negz avatar Feb 03 '23 21:02 negz