search

giantswarm / docs

The Giant Swarm documentation site
http://docs.giantswarm.io
Apache License 2.0
4 stars 8 forks source link

Adapt content to style guide #2191

Closed marians closed 4 months ago

marians commented 4 months ago

This PR adapts existing content (except for vintage and changes) to our style guide, so that we get a consistent starting point with minimal linter warnings.

There is one error remaining which I don't know how to get rid of:

 src/content/reference/fleet-management/clusters/migration_to_cluster_api.md
 56:35  error  Avoid using 'k8s'.  Vale.Avoid

This comes from the app name k8s-initiator-app. We still have to find out how to make exclusions for a term. I could add an exclusion comment above the paragraph. But that would mean that for the entire paragraph, all Vale.Avoid rules would become inactive. I don't want that.

This PR also shows me that despite that error, the Vale check for this PR appears as successful. This has to be fixed separately, too.

image

marians commented 4 months ago

LGTM maybe closing the app name between quotes will solve it (though it means we need to do it for all)

Indeed, backtick comments would work, but I think it's the wrong thing to do, in terms of style/formatting.