Kramdown warnings for markdown
Problem to solve
When the docs site is built, Kramdown generates a lot of warnings due to various minor issues in markdown, usually due to the use of [ and ] for content that isn't a link. I have filtered out the "known" warnings (from our badge implementation):
Further details
Kramdown Warning List
kramdown warning(s) for <Nanoc::CompilationItemRepView item.identifier=/ce/topics/autodevops/index.md name=default>
Found block HTML tag 'ul' in span-level text on line 787
Found block HTML tag 'li' in span-level text on line 787
Found invalidly used HTML closing tag for 'li' on line 787
Found block HTML tag 'li' in span-level text on line 787
Found invalidly used HTML closing tag for 'li' on line 787
Found invalidly used HTML closing tag for 'ul' on line 787
Found block HTML tag 'ul' in span-level text on line 1
Found block HTML tag 'li' in span-level text on line 1
Found invalidly used HTML closing tag for 'li' on line 1
Found block HTML tag 'li' in span-level text on line 1
Found invalidly used HTML closing tag for 'li' on line 1
Found invalidly used HTML closing tag for 'ul' on line 1
kramdown warning(s) for <Nanoc::CompilationItemRepView item.identifier=/ce/legal/individual_contributor_license_agreement.md name=default>
No link definition for link ID 'insert_name_here' found on line 24
kramdown warning(s) for <Nanoc::CompilationItemRepView item.identifier=/ce/legal/corporate_contributor_license_agreement.md name=default>
No link definition for link ID 'name of your corporation here' found on line 22
No link definition for link ID 'named here' found on line 28
kramdown warning(s) for <Nanoc::CompilationItemRepView item.identifier=/ce/ci/variables/predefined_variables.md name=default>
No link definition for link ID 'triggered' found on line 1
kramdown warning(s) for <Nanoc::CompilationItemRepView item.identifier=/ce/integration/elasticsearch.md name=default>
No link definition for link ID 'optional' found on line 173
kramdown warning(s) for <Nanoc::CompilationItemRepView item.identifier=/ce/user/permissions.md name=default>
Footnote definition for '4' not found on line 1
Footnote definition for '4' not found on line 1
kramdown warning(s) for <Nanoc::CompilationItemRepView item.identifier=/ce/user/markdown.md name=default>
No link definition for link ID '- deletions -' found on line 250
Footnote definition for '1' on line 1084 is unreferenced - ignoring
kramdown warning(s) for <Nanoc::CompilationItemRepView item.identifier=/ce/user/project/canary_deployments.md name=default>
No link definition for link ID 'auto deploy' found on line 50
kramdown warning(s) for <Nanoc::CompilationItemRepView item.identifier=/ce/user/project/merge_requests/work_in_progress_merge_requests.md name=default>
No link definition for link ID 'wip' found on line 17
No link definition for link ID 'wip' found on line 32
kramdown warning(s) for <Nanoc::CompilationItemRepView item.identifier=/ce/user/project/integrations/prometheus_library/nginx_ingress_vts.md name=default>
No link definition for link ID '2m' found on line 1
No link definition for link ID '2m' found on line 1
No link definition for link ID '2m' found on line 1
No link definition for link ID '2m' found on line 1
kramdown warning(s) for <Nanoc::CompilationItemRepView item.identifier=/ce/user/project/integrations/prometheus_library/haproxy.md name=default>
No link definition for link ID '2m' found on line 1
No link definition for link ID '2m' found on line 1
No link definition for link ID '2m' found on line 1
kramdown warning(s) for <Nanoc::CompilationItemRepView item.identifier=/ce/user/project/integrations/prometheus_library/nginx_ingress.md name=default>
No link definition for link ID '2m' found on line 1
No link definition for link ID '2m' found on line 1
No link definition for link ID '2m' found on line 1
No link definition for link ID '2m' found on line 1
No link definition for link ID '2m' found on line 1
No link definition for link ID '2m' found on line 1
kramdown warning(s) for <Nanoc::CompilationItemRepView item.identifier=/ce/user/project/integrations/prometheus_library/nginx.md name=default>
No link definition for link ID '2m' found on line 1
No link definition for link ID '2m' found on line 1
No link definition for link ID '2m' found on line 1
No link definition for link ID '2m' found on line 1
kramdown warning(s) for <Nanoc::CompilationItemRepView item.identifier=/ce/user/clusters/applications.md name=default>
No link definition for link ID 'auto devops' found on line 116
kramdown warning(s) for <Nanoc::CompilationItemRepView item.identifier=/ce/administration/monitoring/prometheus/gitlab_metrics.md name=default>
No link definition for link ID 'experimental' found on line 114
kramdown warning(s) for <Nanoc::CompilationItemRepView item.identifier=/ce/administration/auth/ldap.md name=default>
Duplicate link ID '//' on line 6 - overwriting
Duplicate link ID '//' on line 8 - overwriting
kramdown warning(s) for <Nanoc::CompilationItemRepView item.identifier=/ce/administration/high_availability/load_balancer.md name=default>
Footnote definition for '2' not found on line 1
Footnote definition for '3' not found on line 1
Footnote definition for '3' not found on line 1
Footnote definition for '4' not found on line 1
Footnote definition for '2' not found on line 109
Footnote definition for '3' not found on line 112
Footnote definition for '4' not found on line 115
kramdown warning(s) for <Nanoc::CompilationItemRepView item.identifier=/ce/administration/high_availability/redis.md name=default>
No link definition for link ID ''redis_sentinel_role', 'redis_master_role'' found on line 401
No link definition for link ID ''redis_sentinel_role', 'redis_slave_role'' found on line 450
kramdown warning(s) for <Nanoc::CompilationItemRepView item.identifier=/ce/administration/geo/replication/updating_the_geo_nodes.md name=default>
No link definition for link ID 'primary' found on line 36
No link definition for link ID 'primary' found on line 63
No link definition for link ID 'secondary' found on line 70
No link definition for link ID 'secondary' found on line 94
No link definition for link ID 'secondary' found on line 175
No link definition for link ID 'database-replication' found on line 247
No link definition for link ID 'database-replication' found on line 247
No link definition for link ID 'secondary' found on line 266
No link definition for link ID 'secondary' found on line 272
No link definition for link ID 'primary' found on line 279
No link definition for link ID 'primary' found on line 283
No link definition for link ID 'secondary' found on line 292
No link definition for link ID 'secondary' found on line 294
No link definition for link ID 'secondary' found on line 300
No link definition for link ID 'secondary' found on line 306
No link definition for link ID 'secondary' found on line 312
No link definition for link ID 'secondary' found on line 315
No link definition for link ID 'secondary' found on line 321
No link definition for link ID 'secondary' found on line 327
No link definition for link ID 'secondary' found on line 333
No link definition for link ID 'secondary' found on line 340
No link definition for link ID 'database-source-replication' found on line 341
No link definition for link ID 'database-source-replication' found on line 341
No link definition for link ID 'secondary' found on line 343
No link definition for link ID 'secondary' found on line 390
No link definition for link ID 'secondary' found on line 397
No link definition for link ID 'secondary' found on line 403
No link definition for link ID 'secondary' found on line 409
No link definition for link ID 'primary' found on line 411
kramdown warning(s) for <Nanoc::CompilationItemRepView item.identifier=/ce/install/installation.md name=default>
No link definition for link ID 'remote rejected' found on line 562
kramdown warning(s) for <Nanoc::CompilationItemRepView item.identifier=/ce/install/README.md name=default>
create [0.00s] public/ce/install/google_cloud_platform/img/ssh_terminal.pngkramdown warning(s) for <Nanoc::CompilationItemRepView item.identifier=/ce/customization/system_header_and_footer_messages.md name=default>
No link definition for link ID 'ee-1283' found on line 6
No link definition for link ID 'ee-1283' found on line 6
No link definition for link ID 'eep' found on line 6
No link definition for link ID 'eep' found on line 6
kramdown warning(s) for <Nanoc::CompilationItemRepView item.identifier=/ce/workflow/notifications.md name=default>
No link definition for link ID '1' found on line 1
No link definition for link ID '1' found on line 1
kramdown warning(s) for <Nanoc::CompilationItemRepView item.identifier=/ce/workflow/repository_mirroring.md name=default>
No link definition for link ID 'core' found on line 41
No link definition for link ID 'core' found on line 71
No link definition for link ID 'core' found on line 81
No link definition for link ID 'core' found on line 297
kramdown warning(s) for <Nanoc::CompilationItemRepView item.identifier=/ce/workflow/gitlab_flow.md name=default>
No link definition for link ID 'wip' found on line 181
kramdown warning(s) for <Nanoc::CompilationItemRepView item.identifier=/ce/api/merge_requests.md name=default>
No link definition for link ID 'integer' found on line 1
No link definition for link ID 'integer' found on line 1
No link definition for link ID 'integer' found on line 1
kramdown warning(s) for <Nanoc::CompilationItemRepView item.identifier=/ce/api/vulnerabilities.md name=default>
No link definition for link ID 'string' found on line 1
No link definition for link ID 'string' found on line 1
No link definition for link ID 'string' found on line 1
kramdown warning(s) for <Nanoc::CompilationItemRepView item.identifier=/ce/api/issues.md name=default>
No link definition for link ID 'string' found on line 1
No link definition for link ID 'integer' found on line 1
No link definition for link ID 'integer' found on line 1
No link definition for link ID 'string' found on line 1
No link definition for link ID 'integer' found on line 1
No link definition for link ID 'string' found on line 1
No link definition for link ID 'integer' found on line 1
No link definition for link ID 'integer' found on line 1
kramdown warning(s) for <Nanoc::CompilationItemRepView item.identifier=/ce/api/issues_statistics.md name=default>
No link definition for link ID 'string' found on line 1
No link definition for link ID 'integer' found on line 1
No link definition for link ID 'integer' found on line 1
No link definition for link ID 'string' found on line 1
No link definition for link ID 'integer' found on line 1
No link definition for link ID 'string' found on line 1
kramdown warning(s) for <Nanoc::CompilationItemRepView item.identifier=/ce/api/pipelines.md name=default>
No link definition for link ID '{ 'key' => 'upload_to_s3', 'variable_type' => 'file', 'value' => 'true' }' found on line 1
kramdown warning(s) for <Nanoc::CompilationItemRepView item.identifier=/ce/api/services.md name=default>
No link definition for link ID 'trans' found on line 1
No link definition for link ID 'trans' found on line 1
kramdown warning(s) for <Nanoc::CompilationItemRepView item.identifier=/ce/api/group_milestones.md name=default>
No link definition for link ID 'integer' found on line 1
kramdown warning(s) for <Nanoc::CompilationItemRepView item.identifier=/ce/api/milestones.md name=default>
No link definition for link ID 'integer' found on line 1
kramdown warning(s) for <Nanoc::CompilationItemRepView item.identifier=/ce/api/runners.md name=default>
No link definition for link ID 'string' found on line 1
No link definition for link ID 'string' found on line 1
No link definition for link ID 'string' found on line 1
No link definition for link ID 'string' found on line 1
kramdown warning(s) for <Nanoc::CompilationItemRepView item.identifier=/ce/development/changelog.md name=default>
No link definition for link ID 'some text' found on line 68
kramdown warning(s) for <Nanoc::CompilationItemRepView item.identifier=/ce/development/contributing/issue_workflow.md name=default>
No link definition for link ID 'core team' found on line 290
No link definition for link ID 'core team' found on line 301
kramdown warning(s) for <Nanoc::CompilationItemRepView item.identifier=/ce/development/elasticsearch.md name=default>
No link definition for link ID '95%' found on line 156
kramdown warning(s) for <Nanoc::CompilationItemRepView item.identifier=/ce/development/api_graphql_styleguide.md name=default>
No link definition for link ID 'graphql api' found on line 8
kramdown warning(s) for <Nanoc::CompilationItemRepView item.identifier=/ce/development/automatic_ce_ee_merge.md name=default>
No link definition for link ID 'ce-mr-link' found on line 121
No link definition for link ID 'a > b > c > d' found on line 131
No link definition for link ID 'a > b > c > d' found on line 151
kramdown warning(s) for <Nanoc::CompilationItemRepView item.identifier=/ce/development/file_storage.md name=default>
No link definition for link ID '0..1' found on line 1
No link definition for link ID '2..3' found on line 1
kramdown warning(s) for <Nanoc::CompilationItemRepView item.identifier=/ce/development/architecture.md name=default>
No link definition for link ID 'gitlab-monitor-charts' found on line 233
No link definition for link ID 'gitlab-monitor-charts' found on line 233
No link definition for link ID 'gitlab-workhorse-omnibus' found on line 269
No link definition for link ID 'gitlab-workhorse-omnibus' found on line 269
No link definition for link ID 'gitlab-workhorse-charts' found on line 269
No link definition for link ID 'gitlab-workhorse-charts' found on line 269
kramdown warning(s) for <Nanoc::CompilationItemRepView item.identifier=/ce/development/database_debugging.md name=default>
Found no end tag for 'my' (line 9) - auto-closing it
kramdown warning(s) for <Nanoc::CompilationItemRepView item.identifier=/ce/development/testing_guide/index.md name=default>
Footnote definition for '1' on line 86 is unreferenced - ignoring
kramdown warning(s) for <Nanoc::CompilationItemRepView item.identifier=/ce/development/testing_guide/end_to_end/index.md name=default>
Found invalidly used HTML closing tag for 'b' on line 85 - ignoring it
kramdown warning(s) for <Nanoc::CompilationItemRepView item.identifier=/ce/development/testing_guide/frontend_testing.md name=default>
Duplicate link ID 'karma' on line 567 - overwriting
kramdown warning(s) for <Nanoc::CompilationItemRepView item.identifier=/ce/development/pry_debugging.md name=default>
Found invalidly used HTML closing tag for 'kbd' on line 79
Found no end tag for 'kdb' (line 79) - auto-closing it
kramdown warning(s) for <Nanoc::CompilationItemRepView item.identifier=/ce/development/fe_guide/vue.md name=default>
No link definition for link ID 'https://vuejs.org/v2/examples/select2.html' found on line 129
No link definition for link ID 'https://vuejs.org/v2/examples/select2.html' found on line 129
kramdown warning(s) for <Nanoc::CompilationItemRepView item.identifier=/ce/development/fe_guide/development_process.md name=default>
No link definition for link ID ' ' found on line 24
No link definition for link ID ' ' found on line 25
No link definition for link ID ' ' found on line 26
No link definition for link ID ' ' found on line 27
No link definition for link ID ' ' found on line 28
No link definition for link ID ' ' found on line 29
No link definition for link ID ' ' found on line 30
No link definition for link ID ' ' found on line 31
No link definition for link ID ' ' found on line 32
No link definition for link ID ' ' found on line 33
No link definition for link ID ' ' found on line 34
No link definition for link ID ' ' found on line 35
No link definition for link ID ' ' found on line 36
No link definition for link ID ' ' found on line 37
No link definition for link ID ' ' found on line 38
No link definition for link ID ' ' found on line 39
No link definition for link ID ' ' found on line 40
No link definition for link ID ' ' found on line 44
No link definition for link ID 'share your work early with reviewers/maintainers' found on line 45
No link definition for link ID ' ' found on line 46
No link definition for link ID ' ' found on line 47
No link definition for link ID ' ' found on line 48
No link definition for link ID ' ' found on line 49
No link definition for link ID ' ' found on line 53
No link definition for link ID ' ' found on line 54
No link definition for link ID ' ' found on line 55
No link definition for link ID ' ' found on line 56
No link definition for link ID ' ' found on line 57
No link definition for link ID ' ' found on line 58
No link definition for link ID ' ' found on line 59
No link definition for link ID ' ' found on line 60
No link definition for link ID ' ' found on line 61
No link definition for link ID ' ' found on line 62Proposal
Update those docs to use () or wrap the square brackets in backticks `.
Edited by Marcel Amirault