Skip to content

Clean up markdown causing warnings in charts docs

Marcel Amirault requested to merge charts-markdown-warnings into master

Some usage of square brackets, or angle brackets, was causing some warnings from the kramdown markdown renderer. This MR adjusts the markdown to fix the warnings and make sure everything renders properly.

Note: I couldn't find a problem with the <sup> tags. No idea why Kramdown doesn't like them.

$ bundle exec nanoc
Loading site… done
kramdown warning(s) for <Nanoc::CompilationItemRepView item.identifier=/charts/charts/gitlab/gitlab-runner/index.md name=default>
  No link definition for link ID '' found on line 1
kramdown warning(s) for <Nanoc::CompilationItemRepView item.identifier=/charts/charts/gitlab/migrations/index.md name=default>
  No link definition for link ID '' found on line 1
kramdown warning(s) for <Nanoc::CompilationItemRepView item.identifier=/charts/installation/command-line-options.md name=default>
  No link definition for link ID '{"name": "registry"}' found on line 1
  No link definition for link ID '' found on line 1
kramdown warning(s) for <Nanoc::CompilationItemRepView item.identifier=/charts/development/changelog.md name=default>
  No link definition for link ID 'some text' found on line 65
kramdown warning(s) for <Nanoc::CompilationItemRepView item.identifier=/charts/development/index.md name=default>
  No link definition for link ID 'checkconfig template' found on line 257
  No link definition for link ID '' found on line 257
  No link definition for link ID 'checkconfig.md' found on line 259
  No link definition for link ID 'checkconfig.md' found on line 259
kramdown warning(s) for <Nanoc::CompilationItemRepView item.identifier=/charts/development/release.md name=default>
  Found invalidly used HTML closing tag for 'sup' on line 64
  Found invalidly used HTML closing tag for 'sup' on line 65
  Found invalidly used HTML closing tag for 'sup' on line 1
  Found invalidly used HTML closing tag for 'sup' on line 1
kramdown warning(s) for <Nanoc::CompilationItemRepView item.identifier=/charts/development/minikube/index.md name=default>
  No link definition for link ID 'minikube-getting-started' found on line 8
  No link definition for link ID 'minikube-getting-started' found on line 8
  Found no end tag for 'name' (line 226) - auto-closing it

Related to https://gitlab.com/charts/gitlab/issues/1529

Edited by Marcel Amirault

Merge request reports