Gluon templates have markdown in them that violate our linter
Bug
Description
The gluon instructions for updating readmes appears to reference templates that have markdown in them that violate our linting guidelines.
Every time I regenerate a readme I get a pretty standard set of linter warnings
README.md:7 MD022/blanks-around-headings Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "## Upstream References"]
README.md:8 MD032/blanks-around-lists Lists should be surrounded by blank lines [Context: "* <https://bitnami.com>"]
README.md:12 MD022/blanks-around-headings Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "## Learn More"]
README.md:13 MD032/blanks-around-lists Lists should be surrounded by blank lines [Context: "* [Application Overview](docs/..."]
README.md:24:1 MD034/no-bare-urls Bare URL used [Context: "https://helm.sh/docs/intro/ins..."]
README.md:29 MD032/blanks-around-lists Lists should be surrounded by blank lines [Context: "* cd into directory"]
README.md:30 MD031/blanks-around-fences Fenced code blocks should be surrounded by blank lines [Context: "```bash"]
You can test this fairly easily with by regenerating a readme, running the markdown linter, fixing the errors, then running it again and watch them come back
For a real life example, consider this MR:
- Fixed markdown linting in this commit
- Pipelines passed
- Pushed up a change to the readme that was generated with gluon
- Pipelines failed
- Pushed up the exact same fixes again
- Pipelines pass
BigBang Version
NA
Edited by Andrew Kesterson