Our lesson plans have code snippets. We’ve moved from storing the lesson plans on this team handbook to GitHub and then to Learn. As such, some bits of code may not be formatted correctly.
We are using the Edit Flow plugin to create administrative taxonomy. This will not display on the published view of the site.
When you visit Lesson Plans > All Lessons, you can view the columns where the taxonomy is available.
Within each lesson, look also at the Editorial Metadata. This may appear in the right sidebar under the document tab OR beneath the post editor content.
Proofreading Pass
Contributions are welcome to do a quick pass to ensure formatting has been established and for any obvious code conversion issues.
- Leave a message in the Training team Slack for the fastest access to the Learn site expressing interest in contributing.
- View Lesson Plans > All Lessons on Learn to locate which plans contain a code snippet.
- Edit a lesson that contains a snippet.
When converting posts to the Block Editor mode, code snippets will default to a Code block. Modify this to the Syntax Highlighter block.
At this point, it may be beneficial to cross-check code with what appears on GitHub. A few cases of code not displaying in the editor but being live and inaccurate have occurred on published lesson plans. Copy/pasting from GitHub to Syntax Highlighter block usually works.
Then in the right sidebar, select the language with Line Numbers enabled.
When you’ve finished proofreading each lesson, check the Edit Flow box for Code snippet proofread.
Code Snippet Testing
- Leave a message in the Training team Slack for the fastest access to the Learn site expressing interest in contributing.
- View Lesson Plans > All Lessons on Learn to locate which plans contain a code snippet.
- Edit a lesson that contains a snippet.
Many of these code snippets are rather dated. Run through the lesson and test the snippets displayed.
- If you are able to confirm that it works, great! Check
Code snippet passes - If the code does not work but you can provide new code that does work, great!
Code provided - If the code in the lesson does not work and needs a different contributor to provide that, great.
Code did not pass
Indicate in Edit Flow the status of the code snippets as you have reviewed each.
Let Us Know
We don’t have a great way to detect the progress made and do want to give props to those contributing.