cnti-testcatalog / testsuite

📞📱☎️📡🌐 Cloud Native Telecom Initiative (CNTI) Test Catalog is a tool to check for and provide feedback on the use of K8s + cloud native best practices in networking applications and platforms
https://wiki.lfnetworking.org/display/LN/Test+Catalog
Apache License 2.0
169 stars 70 forks source link

Draft: docs: Add linter for the documentation #2089

Open kosstennbl opened 4 days ago

kosstennbl commented 4 days ago

Description

Add mdl as a linter for new cnf-testsuite documentation Add custom rules for keeping format of the documentation Add lint to git workflows to run mdl. Remove docs directory from .gitignore Fix small issues in documentation for linter to pass.

Issues:

Refs: #1945

martin-mat commented 3 days ago
  1. I'm wondering whether it is a good place to store *.rb rules in the doc directory. To me it looks like CI tooling issue and perhaps should be somewhere else, like /utils dir ...?
  2. ~How do we handle introduced ruby dependency (although for CI/testing purposes only)?~ I see, handled inside container in gh actions.
  3. Can we exclude the doc linters/workflow from triggering the crystal workflow?