From 50a9d0ddde4faa72eae4d81e904b766114714cb6 Mon Sep 17 00:00:00 2001 From: Patrice Ferlet Date: Sun, 3 Aug 2025 22:53:53 +0200 Subject: [PATCH] feat(md): fixes typo and rules --- README.md | 2 +- doc/docs/.markdownlint.yaml | 3 +++ doc/docs/dependencies.md | 8 ++++---- 3 files changed, 8 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index d4e93a2..a8f3797 100644 --- a/README.md +++ b/README.md @@ -186,7 +186,7 @@ services: database: image: mariadb:10 env_file: - # this valuse will be added in a configMap + # this values will be added in a configMap - my_env.env environment: MARIADB_USER: foo diff --git a/doc/docs/.markdownlint.yaml b/doc/docs/.markdownlint.yaml index ccc15b1..d246b85 100644 --- a/doc/docs/.markdownlint.yaml +++ b/doc/docs/.markdownlint.yaml @@ -4,3 +4,6 @@ MD022: false MD033: false MD041: false MD046: false +# list indentation +MD007: + indent: 4 diff --git a/doc/docs/dependencies.md b/doc/docs/dependencies.md index c18f8da..b0a0a9e 100644 --- a/doc/docs/dependencies.md +++ b/doc/docs/dependencies.md @@ -3,14 +3,14 @@ Katenary uses `compose-go` and several Kubernetes official packages. - `github.com/compose-spec/compose-go`: to parse compose files. It ensures : - - that the project respects the "compose" specification - - that Katenary uses the "compose" struct exactly the same way `podman compose` or `docker copose` does + - that the project respects the "compose" specification + - that Katenary uses the "compose" struct exactly the same way `podman compose` or `docker compose` does - `github.com/spf13/cobra`: to parse command line arguments, sub-commands and flags. It also generates completion for bash, zsh, fish and PowerShell. - `github.com/thediveo/netdb`: to get the standard names of a service from its port number - `gopkg.in/yaml.v3`: - - to generate `Chart.yaml` and `values.yaml` files (only) - - to parse Katenary labels in the compose file + - to generate `Chart.yaml` and `values.yaml` files (only) + - to parse Katenary labels in the compose file - `k8s.io/api` and `k8s.io/apimachinery` to create Kubernetes objects - `sigs.k8s.io/yaml`: to generate Katenary YAML files in the format of Kubernetes objects