Add script for auditing Kramdown usage
What does this MR do and why?
Adds a bash script to detect Kramdown syntax in the docs. Kramdown will not be supported on the Hugo site. Kramdown usage will need to be evaluated on a case-by-case basis, so we are not attempting to do a bulk-update on these, we're just detecting them for now.
This MR also makes one configuration change to align Hugo/Goldmark's behavior with GitLab Kramdown: we are disabling the linkify plugin, which automatically creates hyperlinks on URLs. This is to match the behavior in GitLab Kramdown (autolink defaults to false: https://gitlab.com/gitlab-org/ruby/gems/gitlab_kramdown#configuration-parameters).
Closes #16 (closed)
Screenshots, screen recordings, or links to review app
- Kramdown audit running on the pipeline: https://gitlab.com/gitlab-org/technical-writing-group/gitlab-docs-hugo/-/jobs/6596402157#L122
How to set up and validate locally
Numbered steps to set up and validate the change are strongly suggested.
-
Configure a local GitLab Docs environment: https://gitlab.com/gitlab-org/technical-writing-group/gitlab-docs-hugo/-/blob/main/doc/setup.md. -
Run the Kramdown audit script: make kramdown-audit
Merge request acceptance checklist
This checklist encourages us to confirm any changes have been analyzed to reduce risks in quality, performance, reliability, security, and maintainability.
-
I have evaluated the MR acceptance checklist for this merge request.
Closes #16 (closed)