Best practices and tips

Best practice for editing files

Before making any changes/edits, go to GH Desktop and ensure your local repository is up to date: click Fetch origin and click Pull origin if you see that there are changes that you have not pulled (updated) in your local repository. This is indicated by a small notification dot with the number of upcoming changes.

To edit a topic, click on a file in the left navigation pane to open the file contents in the right editing pane. After finishing your updates, click Ctrl-S or File > Save to save your changes.

How to comment out text:  Enclose text with <!--xxx-->, where xxx is the text.

About DCO

"...technically every commit should be signed off as that is the idea behind DCO automation".

You can enable the DCO signoff tool https://github.com/coderanger/dco on PC if you don't want to copy/paste your signature in every commit manually. This works when committing via command-line or Github Desktop.

If you make commits directly in the GitHub UI, you still must paste your signature into the commit.

About branch and repo management

Periodically clean up unused branches and repos that you own.

Embed videos in docs

Example:  https://zowe.github.io/docs-site/latest/getting-started/overview.html

Code: 

<iframe class="embed-responsive-item" id="youtubeplayer" title="Zowe overview demo" type="text/html" width="640" height="390" src="https://www.youtube.com/embed/NX20ZMRoTtk" frameborder="0" webkitallowfullscreen mozallowfullscreen allowfullscreen> </iframe>