DocOps Pipeline for LM (MVP 2)

[cloudjumpercat]

AC:

• [x] Set up Vale to check PRs for style guide violations.
• [x] Set up Vale to check PRs for specialty configured style guide rules
• [x] figure out SEO
• [ ] Build the docs to a local host/AWS environment as a staging environment for testing before it is deployed to the main branch
• [x] Versioned documentation strategy (see: https://github.com/github/docs/blob/main/contributing/liquid-helpers.md) Findings: I should ask GH reps about canary releases, but so far, the best option to me seems to be to use Liquid variables in the front matter that you could then make a version picker on the pages site that uses the Liquid variables. Here's the Jekyll doc: https://jekyllrb.com/docs/front-matter/
• [x] Make a Vale file that warns on words that should be keys/variables instead of plain text
• [ ] Have the markdown linter only look through the most recent commit instead of the whole repo
• [x] have the markdown linter annotate errors
• [x] figure out how to do variables (check out GH's repo)
• [x] figure out how to do reuse
• [x] Set up Pages with folder structure to have nested topics
• [x] Figure out how add READMEs to certain folders without processing them in the final Pages output (Note: set published front matter to "false")
• [x] run markdown conversion script
• [x] make link checker GH action
• [x] is there a way to auto add a TC reviewer to a doc change story? Possible ideas of how this could be done: GH action based on the branch name, folder the file was changed in. I'm trying to see if docs living by the code is feasible in a way that devs can't mess with the docs content without a review from TC. (Findings: Yes, you can do it like this and select "load balancing" for the algorithm https://docs.github.com/en/organizations/organizing-members-into-teams/managing-code-review-settings-for-your-team#configuring-auto-assignment)
• [ ] GH ❤️ Jira integration
• [ ] (optional) try adding GFM to script to see if it fixes some of the table issues (need to add ruby to the bash script)

[cloudjumpercat]

Here's a cool add on to Vale, a reading level yml file: https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/.vale/gitlab/ReadingLevel.yml

[cloudjumpercat]

Check out the linkcheck GH Action for a link checker (can be used in conjunction with the create-issue-from-file action to auto generate an issue with the links that need to be fixed).

Variables and Reuse: GH's docs repo for their data is here

[cloudjumpercat]

Jekyll gem link checker: https://github.com/endymion/link-checker

[cloudjumpercat]

https://confluence.atlassian.com/automation/how-to-integrate-jira-and-github-using-automation-for-jira-993924741.html