cdk8s-team / cdk8s

Define Kubernetes native apps and abstractions using object-oriented programming
https://cdk8s.io
Apache License 2.0
4.29k stars 291 forks source link

[Suggestion] cdk8s documentation should follow k8s documentation style guide #62

Closed campionfellin closed 4 years ago

campionfellin commented 4 years ago

Is your feature request related to a problem? Please describe. A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

Documentation for cdk8s can be written by many people, with different styles of writing. In the CONTRIBUTING.md guide, we should suggest that contributors use the k8s style guide found here

Describe the solution you'd like A clear and concise description of what you want to happen.

A quick sentence and/or paragraph in CONTRIBUTING.md that points to the k8s documentation style guide.

Describe alternatives you've considered A clear and concise description of any alternative solutions or features you've considered.

Additional context Add any other context or screenshots about the feature request here.

campionfellin commented 4 years ago

Closing this. It's not clearly actionable and cdk8s documentation is fine for now.