search

keptn-sandbox / new-keptn-docs-engine

GSoC 2022 Project: New Documentation Site Engine
https://keptn-experimental-docs-site.netlify.app/
Apache License 2.0
6 stars 2 forks source link

Research: How can we add linting for front matter #7

Open imsingh opened 2 years ago

imsingh commented 2 years ago

We should add frontmatter linting or validation to make sure certain frontmatter is always on each doc page. For instance, if we want a description on every page, we can add a linter to make sure everyone follows this guideline.

cc @iamrajiv @oleg-nenashev @vadasambar

oleg-nenashev commented 2 years ago

To be honest I would be careful with standardizing content formatting in a big community. Some maintenance of integration services may have strong and different opinions of how the content should be formatted. And these opinions might be different.

We could of course enforce some rules that impact the stability and visualization, but I would be careful with just syntax.

A solution for that could be a set of template GitHub action checks with some usage documentation. There are plenty of markdown lint steps out there, so having a common template in .github would be nice anyway.

aepfli commented 2 years ago

regarding markdownlint, I can also highlight https://github.com/keptn/keptn.github.io/pull/1235 - which would also provide a make target for local development, hence that makes it easier for local usage. Regarding rules I have to agree with @oleg-nenashev, I would use it to prevent general structural errors, but would not go too heavy on standard formatting.