Skip to content

Remove empty line in README files that breaks the front matter...#451

Merged
J12934 merged 4 commits intomainfrom
fix-broken-front-matter
May 25, 2021
Merged

Remove empty line in README files that breaks the front matter...#451
J12934 merged 4 commits intomainfrom
fix-broken-front-matter

Conversation

@twwd
Copy link
Contributor

@twwd twwd commented May 25, 2021

and is caused by the license headers.

Description

The docs for scanners on https://docs.securecodebox.io/docs/getting-started/installation are broken since docusaurus does not recognize front matter if it does not start on the first line of the markdown file. Due to the introduction of license headers, the wrong Go template comment ({{ /* */ }} vs. {{- /* */ -}}) was used and lead to the preceding empty line. This PR switches to the Go template comments that trim white space around (see https://golang.org/pkg/text/template/#hdr-Actions).

Checklist

  • Test your changes as thoroughly as possible before you commit them. Preferably, automate your test by unit/integration tests.
  • Make sure npm test runs for the whole project.
  • Make codeclimate checks happy

… caused by the license headers

Signed-off-by: Tim Walter <[email protected]>
@twwd twwd requested review from Weltraumschaf and rfelber May 25, 2021 13:57
@J12934 J12934 enabled auto-merge May 25, 2021 14:03
@twwd twwd added the bug Bugs label May 25, 2021
@rfelber rfelber added the documentation Improvements or additions to documentation label May 25, 2021
@J12934 J12934 merged commit 7cabf33 into main May 25, 2021
@J12934 J12934 deleted the fix-broken-front-matter branch May 25, 2021 17:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bug Bugs documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants