fix(ci): Re-add markdown and cue checks #9285
Conversation
|
✔️ Deploy Preview for vector-project ready! 🔨 Explore the source changes: a24132a 🔍 Inspect the deploy log: https://app.netlify.com/sites/vector-project/deploys/614a07baf04edf000884d8f0 😎 Browse the preview: https://deploy-preview-9285--vector-project.netlify.app |
| @@ -6,6 +6,6 @@ layout: component | |||
| tags: ["aws", "cloudwatch", "component", "sink", "logs"] | |||
| --- | |||
|
|
|||
| {{/* This doc is generated using: | |||
| {{/*This doc is generated using: | |||
There was a problem hiding this comment.
Basically the reason I disabled these is that the Markdown linter doesn't "understand" Go templating, which means that using the linter will invariably force us into awkwardnesses like these. I'm fine with the linter for the RFCs and things like that but for the docs I'd prefer to disable it, as it's simply not syntax aware and I question its value.
There was a problem hiding this comment.
In particular I'm referring to this:
{{/*This doc is generated using:
1. The template in layouts/docs/component.html
2. The relevant CUE data in cue/reference/components/...*/}}
There was a problem hiding this comment.
Yeah, this is fair. If the linter doesn't gracefully Go templates, then I can see why we wouldn't want to use it for the Hugo markdown files. I'll see if I can fix this particular issue. That seems to me to be the only undesirable change in this PR.
There was a problem hiding this comment.
I fixed this in a24132a which I personally think results in more readable comments.
There was a problem hiding this comment.
@jszwedko Okay, I'm satisfied with that. If more edge cases like this pop up we could maybe disable the linter in a granular way (e.g. exclude website/content/en/docs/reference/configuration/{sinks,sources,transforms}/* but I think we're good for now.
There was a problem hiding this comment.
Thanks! Yeah, that makes sense, we can definitely keep an eye out for if it starts requiring less readable docs.
| @@ -9,6 +9,7 @@ tags: ["aws", "cloudwatch", "logs", "firehose", "advanced", "guides", "guide"] | |||
| --- | |||
|
|
|||
| {{< requirement title="Pre-requisites" >}} | |||
|
|
|||
There was a problem hiding this comment.
This is another one of the awkwardnesses I was referring to. To me these empty lines look not awesome.
There was a problem hiding this comment.
I actually like the whitespace here, but honestly it doesn't matter to me as long as it is consistent which is the value that I think a linter provides.
|
As noted in my comments, overall I question the value of the Markdown linter in |
Fair compromise to run them only outside of the |
Signed-off-by: Jesse Szwedko <jesse@szwedko.me>
I think consternation is part of the role of a linter 😄 I personally see value in having consistently formatted cue and markdown, even in the website directory. The linter can be run locally when making changes. We can keep an eye out to see if it starts causing a lot of pain with Go templates though. |
These were (accidentally?) removed in
#7368
Includes markdown fixes.
Closes: #9270