Skip to content

Updates docs to be compatible with mkdocs 1.1.2

Nizar requested to merge nizar/fix-mkdocs-1.1.2 into master

This pull request adds :

  • Markdown Linter
  • Build Integrity Check post build

If you check the handbook at the moment, before the pull request is merged, you'll notice that some of the headers don't show up in the navigation bar for the markdown files mentioned above.

There are a lot of factors that come into play here, which are mainly related to headers needing a single parent. In addition, it is mostly related to always have a directly higher level parent to the header, meaning header 3s need to be contained in header 1s.

JIRA tickets: SE-4028

Discussions:

Sandbox URL: https://handbook.opencraft.com/en/nizar-fix-mkdocs-1.1.2/

Testing instructions:

Multiple things need to be tested

Testing pipeline

  • In order to test the pipeline, you'll want to view the pull request's pipeline and verify that the quality check is being run.
  • Make sure that No Markdown Errors shows up in the pipeline logs.

Testing the quality check

  • In order to test the quality check, you'll need to run make quality on your local machine.
  • The new quality check checks if there are more than a single header 1 in the doc file, because having more than 1 interferes with the navigation bar's rendering.
  • Revert some of the "fix" commits that were submitted to this pull request, locally, and run the quality check to make sure you notice the errors.

Testing the navigation

  • Open the sandbox and verify that the navigation items that weren't rendering properly in the live handbook are rendering properly in the current one.

Reviewers

Edited by Nizar

Merge request reports