chore(kb/yaml): add gotcha about key naming convention

This commit is contained in:
Michele Cereda
2024-05-20 18:52:04 +02:00
parent fec4a1834c
commit 01355121de

View File

@@ -1,12 +1,14 @@
# YAML
## Table of contents <!-- omit in toc -->
1. [TL;DR](#tldr)
1. [Further readings](#further-readings)
## TL;DR
There is no key naming convention.<br/>
Best practice is to use the one used by the users or tools using that file (e.g.: Kubernetes --> camelCase, CircleCI -->
snake_case, Jenkins --> kebab-case).
```yaml
---
# This is a comment
@@ -22,19 +24,23 @@ object:
can: do
lists:
- too
"key:with:chars": requiring quotation
```
## Further readings
- [yaml-multiline.info]
- [`yamllint`][yamllint]
- [What is the canonical YAML naming style]
<!--
References
Reference
═╬═Time══
-->
<!-- Knowledge base -->
[yamllint]: yamllint.md
<!-- Others -->
[what is the canonical yaml naming style]: https://stackoverflow.com/questions/22771226/what-is-the-canonical-yaml-naming-style
[yaml-multiline.info]: https://yaml-multiline.info