From 7389ef3947662eb355920e9fdd5e781dbdaa0726 Mon Sep 17 00:00:00 2001 From: ssube Date: Sun, 30 Jun 2019 16:35:22 -0500 Subject: [PATCH] lint: config markdownlint, fix some docs --- .codeclimate.yml | 3 +-- .mdlrc | 2 ++ README.md | 1 + docs/outline.md | 30 +++++++++++++++--------------- 4 files changed, 19 insertions(+), 17 deletions(-) create mode 100644 .mdlrc diff --git a/.codeclimate.yml b/.codeclimate.yml index 77da81d..1a2114f 100644 --- a/.codeclimate.yml +++ b/.codeclimate.yml @@ -1,8 +1,7 @@ version: "2" exclude_patterns: - - docs/dev/style.md - - src/migration/ + - CHANGELOG.md - vendor/ plugins: diff --git a/.mdlrc b/.mdlrc new file mode 100644 index 0000000..e60316f --- /dev/null +++ b/.mdlrc @@ -0,0 +1,2 @@ +rules all +rule "MD013", :line_length => 120 \ No newline at end of file diff --git a/README.md b/README.md index 6a5e8ca..4eeefe0 100644 --- a/README.md +++ b/README.md @@ -52,6 +52,7 @@ To download, validate, and apply a Kubernetes resource: {"name":"salty-dog","hostname":"cerberus","pid":7860,"level":30,"msg":"all rules passed","time":"2019-06-16T02:04:37.797Z","v":0} ingress.extensions/gitlab created (dry run) ``` + ## Status [![Pipeline status](https://img.shields.io/gitlab/pipeline/ssube/salty-dog.svg?gitlab_url=https%3A%2F%2Fgit.apextoaster.com&logo=gitlab)](https://git.apextoaster.com/ssube/salty-dog/commits/master) diff --git a/docs/outline.md b/docs/outline.md index 8837cc2..50f8f80 100644 --- a/docs/outline.md +++ b/docs/outline.md @@ -47,21 +47,21 @@ Original rough outline document. ## Run 1. Load source and copy to state -2. Load all fragments in rule paths -3. Build list of applicable rules by level, name, tag -4. For each rule: -5. Select potential nodes -6. Filter applicable nodes -7. Copy fragment -8. Apply schema -9. If schema passes and output matches, log success -10. If schema passes and output differs, log difference -11. If schema fails, log errors and mark error -12. If running in fix mode and schema passed, update state -13. After all rules: -14. If running in fix mode and all rules passed: -15. Log differences between source and state -16. Write state to dest +1. Load all fragments in rule paths +1. Build list of applicable rules by level, name, tag +1. For each rule: +1. Select potential nodes +1. Filter applicable nodes +1. Copy fragment +1. Apply schema +1. If schema passes and output matches, log success +1. If schema passes and output differs, log difference +1. If schema fails, log errors and mark error +1. If running in fix mode and schema passed, update state +1. After all rules: +1. If running in fix mode and all rules passed: +1. Log differences between source and state +1. Write state to dest ## Dependencies