Automate the process for checking broken links / images

[mtspn]

Describe the issue Improve the automation of checking for broken links and images in our documentation.

Definition of done

• [ ] Review and understand the process for link checking in our documentation during the builds of our documentation
• [ ] If image links are not already checked and identified, discuss with DexEx team devs (Monica/Shea) about how this could be included
• [ ] Check all current pages for broken links and images

[Pilargit12]

Process for reviewing broken links:

1. Access https://github.com/bcgov/platform-developer-docs

   

2. Select the latest workflow run
   

3. Select "Usage" from the left side menu

4. Under Run Time screen, select the job
   

5. Select "Build Techdocs"

   
   6. Once selected the build techs will run, it's a long document and it is best to scroll all the way down to review the all of the 4xx errors. 4xx client error means that the request contains bad syntax or cannot be fulfilled, but some of them are common errors where a login is needed and it is reported as not found, so as this exercise is done every so often, one will be able to distinguish from these errors and ignore them, but others will likely to be corrected. For a list of what they mean, this is a useful URL https://en.wikipedia.org/wiki/List_of_HTTP_status_codes

[mtspn]

Do the images show up for you in this issue @Pilargit12 ?

[Pilargit12]

No, they show up like this:

[mtspn]

Okay no worries, like they're broken in github but I can view them normally from within Zenhub.

[mtspn]

Looks good Pilar, thanks for documenting this process too. This might be a good one to highlight in a sprint review.

[Pilargit12]

Thank you Matt, I wonder if I should go to github and attempt to also upload the images there?

[mtspn]

I think it's okay, as this conversation will now prompt anyone looking in github in the future to look at Zenhub ticket