GitHub Mechanics for the Open Documentation Initiative

Explore the automation processes for repositories in the Open Documentation Initiative in this comprehensive video from SAP. Dive into the structure and contents of SAP-docs repositories, learn how to create copies of contribution guidelines, and understand the SAP-codoc app installation. Gain insights into workflow functionalities, including the Markdown linter and disallowed content checker. Follow along as changes are proposed, deliberate mistakes are introduced and fixed, and pull requests are merged. Discover how to handle issues outside the docs directory and learn about CODEOWNERS configuration. By the end of this tutorial, master the GitHub mechanics essential for contributing to and managing open documentation projects.

Start
Welcome and introduction
First Open Documentation Initiative missions recipients!
Reminding ourselves of the structure and contents of the SAP-docs repos
Creating a copy of the contribution-guidelines repo in the test org qmacro-dev-org
Looking at the copy of the SAP-codoc app created & installed on qmacro-dev-org
A high level view of what each workflow does
Proposing a change to contribution-guidelines as a contributor with a deliberate Markdown issue that will be picked up by the linter
Analyzing the execution of the triggered workflows
Talking about what the disallowed content checker does
Looking in detail at the Markdown linter workflow
A quick look at the CODEOWNERS configuration
Looking in detail at the disallowed content checker workflow
Fixing the deliberate mistake with a further commit in the pull request
Deliberately making a change outside of the docs/ directory to trigger the disallowed message
Reverting the disallowed change
Merging the pull request and looking at the subsequent workflow activities that are triggered
Adding the missing label and re-running the workflow