Tools for testing documentation

Like code, documentation needs some and proper testing.

As a first step, we need to see that a couple of things are properly handled:

• Markdown formatting (we can use markdownlint) - https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/4900
• Links should always point to a valid location https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/9509
• Spell checking. This should be better tackled locally by one's editor, but we could at least check for words like GitLab to be spelled correctly.

Custom linting scripts:

• Add linting tool to use the long options in cURL examples https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/5703

@axil Do you know of a way to verify that anchored links point to a valid anchor? I'm constantly worried about changing a header and breaking anchored links.

@rspeicher html-proofer claims to support that.

Ohh I found this neat extension which also claims to support anchor links https://chrome.google.com/webstore/detail/check-my-links/ojkcdipcgfaekbeaelaapakgnjflfglf/related?hl=en-GB

Edit: just tested it on a broken anchor link and it showed a warning :)

mentioned in merge request gitlab-com/www-gitlab-com!1214 (merged)

mentioned in commit gitlab-com/www-gitlab-com@067732fe

Reassigned to @axil

Milestone changed to 8.5

Milestone removed

Added markdown in GitLab FOSS label

mentioned in issue gitlab-foss#14708 (closed)

mentioned in merge request gitlab-foss!4900 (closed)

mentioned in merge request gitlab-foss!5703 (merged)

Like I wrote here, the script I wrote in gitlab-foss!5703 (merged) could be extended to

• find other short options (e.g. sudo)
• find PRIVATE-TOKEN headers which don't use 9koXpg98eAheJpvBs5tK
• find remnants from conflicts (e.g. <<< HEAD)
• check that only Unix line endings are used

mentioned in merge request gitlab-foss!6173 (closed)

removed assignee

changed weight to 5

moved from gitlab-foss#3909 (moved)