doc(lint): experiment markdown linting

.github/.markdownlint.yml

@@ -0,0 +1,30 @@
+# See rules documentation: https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md
+
+# Default state for all rules
+default: true
+
+# ul-style # default: consistent
+MD004: consistent
+
+# hard-tabs
+MD010: false
+
+# line-length
+MD013: false
+
+# no-duplicate-header
+MD024:
+  siblings_only: true
+
+#single-title
+MD025: true
+
+# ol-prefix
+MD029:
+  style: one_or_ordered
+
+# no-inline-html
+MD033: false
+
+# fenced-code-language
+MD040: false

.github/workflows/doc-update.yml

@@ -4,7 +4,6 @@ on:
   workflow_call:
 
 # TODO:
-#  * [] markdown lint
 #  * [] spell checker
 
 permissions:

README.md

@@ -1,19 +1,26 @@
-# ci-workflows
+# ci-workflows[![Build Status](https://github.com/go-openapi/ci-workflows/actions/workflows/go-test.yml/badge.svg)](https://github.com/go-openapi/ci-workflows/actions?query=workflow%3A"go+test") [![codecov](https://codecov.io/gh/go-openapi/ci-workflows/branch/master/graph/badge.svg)](https://codecov.io/gh/go-openapi/ci-workflows)
+
+[![Slack Status](https://slackin.goswagger.io/badge.svg)](https://slackin.goswagger.io)
+[![license](http://img.shields.io/badge/license-Apache%20v2-orange.svg)](https://raw.githubusercontent.com/go-openapi/ci-workflows/master/LICENSE)
+[![Go Reference](https://pkg.go.dev/badge/github.com/go-openapi/ci-workflows.svg)](https://pkg.go.dev/github.com/go-openapi/ci-workflows)
+[![Go Report Card](https://goreportcard.com/badge/github.com/go-openapi/ci-workflows)](https://goreportcard.com/report/github.com/go-openapi/ci-workflows)
 
 Common CI workflows and setup for go-openapi repos.
 
 * shared github action workflows
-* shared dependabot config
+* shared dependabot config (TODO)
+* shared golangci config (**BLOCKED**)
 
-NOTE: at this moment, it is difficult to share the golangci-lint config, so that one is not shared yet.
+> NOTE: at this moment, it is difficult to share the golangci-lint config,
+> so that one is not shared yet.
 
 ## Motivation
 
-It took a while, but we eventually managed to align all checks, tests and dependabot rules declared in the
-family of go-openapi repos.
+It took a while, but we eventually managed to align all checks, tests and
+dependabot rules declared in the family of go-openapi repos.
 
-Now we'd like to be able to maintain, enrich and improve these checks without worrying too much about
-the burden to replicate it about a dozen times.
+Now we'd like to be able to maintain, enrich and improve these checks without
+worrying too much about the burden to replicate it about a dozen times.
 
 ## Contemplated enhancements
 
@@ -28,10 +35,13 @@ In no particular order:
 * [ ] lint: manage somehow to share golangci config (with local merge)
 * [ ] deps: manage somehow to share / replicate dependabot config
 * [ ] lint: golangci-lint: check valid PR comments etc
-* [ ] lint: use non-blocking, scheduled, proactive full linting to check for the impact of new linters, new go versions etc
+* [ ] lint: use non-blocking, scheduled, proactive full linting to check for
+      the impact of new linters, new go versions etc
 * [ ] doc: (possibility) take over hugo & doc gen part from go-swagger
 * [ ] (possibility) take over release part from go-swagger
-* [ ] doc: produce hugo github page with all latest tagged versions (incl. mono repo)
+* [ ] doc: produce hugo github page with all latest tagged versions
+      (incl. mono repo)
 * [ ] add bot to filter PRs, issues
-* [ ] check with github API that all repo settings (branch protection rules, etc) are identical
+* [ ] check with github API that all repo settings (branch protection rules, etc)
+      are identical
 * [ ] comment PRs and issues