Collect notes while reviewing TW Log Checks
Issue Description
@mjang1 plans to use this issue to collect notes as he's responsible for the Log checks reviews for November 2020.
These checks are in five parts:
-
External link checker log: resolve all links from the noted job. Hindsight, I should have copied all of the broken links to a comment to this issue:
- Some broken links are straightforward, e.g.: add a trailing forward slash: https://www.example.com -> https://www.example.com/
- Some companies (I think) include 302s that include a redirect
- CAUTION: the redirect, from what I've seen does NOT include anchor links
- Sometimes, the link disappears entirely. Possible reasons:
- The company may no longer exist
- The external product is EOSL In such cases, you may need to open an issue for TW/group resolution
- Sometimes, the replacement link is not obvious
- Example: when a link goes to an old version of an external product, and a new version doesn't include that info In such cases, you may need to open an issue for TW/group resolution
-
Kramdown build logs
- In my case, I had no Kramdown build log warnings; ref this compile prod CI job
-
Trailing white space test
- In this case, I copied the log to this comment
- Workaround: set up your IDE to automatically remove trailing white space Here's how I set up my vi config file
- For each doc repo (gitlab, charts, omnibus-gitlab, gitlab-runner), I:
- Open a new branch
- Open the file in question
- Save and write the file. (!wq in vi) In my case, vi automatically removes trailing whitespace
- Set up a new MR.
-
Compress images
- Make sure to run the noted rake tasks in a repo subdirectory of gitlab-development-kit
-
Check for unused images
- You'll need to set up the noted
test-script.sh
script in each doc repo - Don't forget to remove
test-script.sh
before setting up the MR
- You'll need to set up the noted
Edited by Mike Jang