Uploaded image for project: 'Mender'
  1. Mender
  2. MEN-3641

Research CI solutions for verifying documentation links

    XMLWordPrintable

    Details

    • Type: Story
    • Status: Done
    • Priority: (None)
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: None
    • Labels:
    • Days in progress:
      0

      Description

      Today we only check validity of links once they are deployed to docs.mender.io, and even if we will find the errors on the "Development" branch, I think it is a bit late to check this once the site is deployed.

      As we are planing to make larger structural change to the docs, chances are very big that we will break the internal links. It is very tedious to test this manually when you create a PR, and testing once deployed is not really option if we are making bigger changes.

      This should be very easy for a machine to test, and there is plenty of tools available, a quick internet search later :

      Ultimately this can added to the CI pipeline which is triggered on each PR.

      A pragmatic approach would be to have a process to run something locally when you are writing docs, this is mostly because I can image that these tools take a while to "tune" to eliminate false positiv results which should be done before we integrate it in the CI pipeline.

      Research solutions for both internal and external link checkers for the mender-docs CI.

        Attachments

          Activity

            People

            • Assignee:
              oleorhagen Ole Petter Orhagen
              Reporter:
              oleorhagen Ole Petter Orhagen
            • Votes:
              0 Vote for this issue
              Watchers:
              3 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved:

                Summary Panel