Remove empty line in README files that breaks the front matter... - #451
Merged
J12934 merged 4 commits intoMay 25, 2021
Merged
Conversation
Copy link
Copy Markdown
Contributor
Sorry, something went wrong.
… caused by the license headers Signed-off-by: Tim Walter <tim.walter@iteratec.com>
J12934
approved these changes
May 25, 2021
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Reviewers
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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