Merge pull request #59 from bcgov/update/confluence-content

Updated content from confluence.

patterns/docs/Source Code Repositories/GitHub Organization Administration/GitHub Organization Administration.md

@@ -66,6 +66,8 @@ Repositories and Branching
 
    - Establish a branching strategy (e.g., Gitflow) for a structured development process.
 
+   - The authority to create BCGOV-C repos will remain with OCIO.
+
 Issue Tracking
 
    - Utilize GitHub Issues for tracking tasks, bugs, and enhancements.

patterns/docs/Source Code Repositories/GitHub Organization Administration/data.json

@@ -1 +1 @@
-{"id":"197493858","type":"page","status":"current","title":"GitHub Organization Administration","body":{"storage":{"value":"<table class=\"wrapped\"><colgroup class=\"\"><col class=\"\" /><col class=\"\" /></colgroup><tbody class=\"\"><tr class=\"\"><th>Status</th><td><div class=\"content-wrapper\"><p>Document</p></div></td></tr><tr class=\"\"><th>Stakeholders</th><td>NRIDS Architecture, FDS</td></tr><tr class=\"\"><th>Description</th><td>The purpose of this page is to outline practices when managing GitHub Org Administration</td></tr><tr class=\"\"><th>Outcome</th><td>Consistent point of reference for onboarding new product teams into the NRM's.</td></tr><tr class=\"\"><th>Owner</th><td>NRIDS Architecture, FDS</td></tr></tbody></table><p><br /></p><p><ac:structured-macro ac:name=\"toc\" ac:schema-version=\"1\" ac:macro-id=\"cc403257-373b-434d-a248-048d9d8bbe8c\" /></p><p><br /></p><h1>Participants</h1><ul><li>Administrators<ul><li>Application Delivery Team</li><li>with support of:<ul><li>1Team</li><li>Derek Roberts</li><li>Om Mishra</li><li>engagement/communication specialists</li><li>security specialists</li></ul></li></ul></li><li>Audience<ul><li>developers</li><li>designers</li><li>devops specialists</li><li>product owners</li><li>internal staff</li></ul></li></ul><ul><li>Advisors – OCIO, Jeff Card, Adam Dewey, Michelle Douville</li></ul><p><br /></p><h1>Costs</h1><ul><li>NRIDS will proceed with a Github Teams License for the BCGOV-NR tenancy <a href=\"https://github.com/bcgov-nr\">https://github.com/bcgov-nr</a></li><li>NRIDS Architecture will continue to engage with OCIOs Platform Services team on their negotiations with Github Enterprise.</li><li>Currently, February 2024, there are less than <ac:inline-comment-marker ac:ref=\"cdde44bb-b669-4f0c-849c-c58161e728e4\">30 participants</ac:inline-comment-marker> in the tenancy and include developers, vendors and internal staff of Team Epsilon, 1Team, DBAs, Application Deliveries, AOT and CGI.</li><li><a href=\"https://github.com/pricing\"><ac:inline-comment-marker ac:ref=\"59447600-6970-42e7-a8e9-5084cc5682e0\">https://github.com/pricing</ac:inline-comment-marker></a></li></ul><p style=\"margin-left: 40.0px;\"><ac:image ac:thumbnail=\"true\" ac:height=\"250\"><ri:attachment ri:filename=\"image-2024-2-28_16-16-9-1.png\" /></ac:image></p><p style=\"margin-left: 40.0px;\"><br /></p><h1>Components of Github Organization Administration</h1><ul><li><h2>Organization Structure &amp; Access Control</h2></li></ul><p style=\"margin-left: 80.0px;\">Organization Structure</p><p style=\"margin-left: 80.0px;\">   - Define a clear organizational structure with teams based on projects or functions.</p><p style=\"margin-left: 80.0px;\">   - Assign <ac:inline-comment-marker ac:ref=\"ee075b6c-e3cc-4844-93d7-3e12f42e5313\">appropriate permissions</ac:inline-comment-marker> to teams and members to control access.</p><p style=\"margin-left: 80.0px;\">Access Control</p><p style=\"margin-left: 80.0px;\">   - Regularly review and update <ac:inline-comment-marker ac:ref=\"0d5f2052-1087-488d-a82b-98b3f22a6fb5\">access permissions</ac:inline-comment-marker>.</p><p style=\"margin-left: 80.0px;\">   - Implement branch protection rules to safeguard critical branches.</p><p style=\"margin-left: 80.0px;\">License Management</p><p style=\"margin-left: 80.0px;\">    - <ac:inline-comment-marker ac:ref=\"e6e79868-dbc4-465b-94a4-c8fce99e6029\">Clearly specify and manage licenses for each repository.</ac:inline-comment-marker></p><p style=\"margin-left: 80.0px;\">    - <ac:inline-comment-marker ac:ref=\"77fad3d2-7c61-4121-b05d-d30bf887a16e\">Regularly review and update licenses as needed.</ac:inline-comment-marker></p><p style=\"margin-left: 80.0px;\"><br /></p><ul><li><h2>Repository Management</h2></li></ul><p style=\"margin-left: 80.0px;\">Repositories and Branching</p><p style=\"margin-left: 80.0px;\">   - <ac:inline-comment-marker ac:ref=\"d7961ca8-e44a-461d-a6a7-6b7d134198e1\">Create repositories for each project or component.</ac:inline-comment-marker></p><p style=\"margin-left: 80.0px;\">   - Establish a branching strategy (e.g., Gitflow) for a structured development process.</p><p style=\"margin-left: 80.0px;\">Issue Tracking</p><p style=\"margin-left: 80.0px;\">   - Utilize <ac:inline-comment-marker ac:ref=\"80977daf-38f9-429e-abdd-f1ffe27158f4\">GitHub Issues</ac:inline-comment-marker> for tracking tasks, bugs, and enhancements.</p><p style=\"margin-left: 80.0px;\">   - Establish labeling conventions for better categorization.</p><p style=\"margin-left: 80.0px;\">Backups and Recovery</p><p style=\"margin-left: 80.0px;\">    - Regularly back up repositories and related data.</p><p style=\"margin-left: 80.0px;\">    - Establish a recovery plan in case of accidental data loss or compromise.</p><p style=\"margin-left: 80.0px;\"><br /></p><ul><li><h2>Code Review Process &amp; Security</h2></li></ul><p style=\"margin-left: 80.0px;\">Code Review Process</p><p style=\"margin-left: 80.0px;\">   -  Implement a code review process to maintain code quality.</p><p style=\"margin-left: 80.0px;\">   - Require reviews before merging, and use pull request templates.</p><p style=\"margin-left: 80.0px;\">Security Measures</p><p style=\"margin-left: 80.0px;\">   - Regularly scan code for vulnerabilities using GitHub code scanning.</p><p style=\"margin-left: 80.0px;\">   - Implement Dependabot for automated dependency updates.</p><p style=\"margin-left: 80.0px;\"><br /></p><ul><li><h2>Automation and CI/CD</h2><p>   - Set up continuous integration and continuous deployment (CI/CD) pipelines.</p><p>   - Use GitHub Actions or other CI/CD tools to automate testing and deployment processes.</p></li><li><h2>Documentation, Collaboration &amp; Community</h2></li></ul><p style=\"margin-left: 80.0px;\">Documentation</p><p style=\"margin-left: 80.0px;\">   - Maintain comprehensive README files for each repository.</p><p style=\"margin-left: 80.0px;\">   - Utilize GitHub Wiki for extensive documentation on larger projects.</p><p style=\"margin-left: 80.0px;\">Collaboration and Communication</p><p style=\"margin-left: 80.0px;\">   - Encourage collaboration through discussion in issues and pull requests.</p><p style=\"margin-left: 80.0px;\">   - Use GitHub Discussions for broader conversations within the organization.</p><p style=\"margin-left: 80.0px;\">Training and Onboarding</p><p style=\"margin-left: 80.0px;\">    - Provide training sessions for new members on GitHub workflows.</p><p style=\"margin-left: 80.0px;\">    - Maintain a detailed onboarding guide for new contributors.</p><p style=\"margin-left: 80.0px;\">Community Guidelines</p><p style=\"margin-left: 80.0px;\">    - Establish and communicate community guidelines for contributors.</p><p style=\"margin-left: 80.0px;\">    - Enforce a code of conduct to ensure a positive and inclusive environment.</p><p style=\"margin-left: 80.0px;\"><br /></p><ul><li><h2>Monitoring and Auditing</h2></li></ul><p style=\"margin-left: 80.0px;\">    - Use GitHub Insights to monitor repository activity and contributions.</p><p style=\"margin-left: 80.0px;\">    - Analyze metrics to identify areas for improvement in development processes.</p><p style=\"margin-left: 80.0px;\">Regular Audits</p><p style=\"margin-left: 80.0px;\">    - Conduct periodic audits of repositories, permissions, and workflows.</p><p style=\"margin-left: 80.0px;\">    - Address any issues or improvements identified during audits.</p><p style=\"margin-left: 80.0px;\">Ie. Script a monthly mail out to Github Team administrators to review team memberships they own.</p><p style=\"margin-left: 80.0px;\">Ie. Script compliance to metadata standards (readme/pubcode) </p><p style=\"margin-left: 80.0px;\"><br /></p><h1>References</h1><p><a href=\"https://stackify.com/managing-teams-github/\">https://stackify.com/managing-teams-github/</a></p><p><a href=\"https://bcgov.sharepoint.com/:b:/t/03678/EYd__CQ_OflDiaukjBDrYp8BsnA5RXqqQEde9IVQR_qM8w?e=HjAJaY\">GitHub in BC Government - RC1.pdf</a></p><p><a class=\"\" href=\"https://developer.gov.bc.ca/docs/default/component/bc-developer-guide/use-github-in-bcgov/github-enterprise-user-licenses-bc-government/\">https://developer.gov.bc.ca/docs/default/component/bc-developer-guide/use-github-in-bcgov</a></p><p><br /></p>","representation":"storage","_expandable":{"content":"/rest/api/content/197493858"}},"_expandable":{"editor":"","view":"","export_view":"","styled_view":"","anonymous_export_view":""}},"extensions":{"position":"none"},"_links":{"webui":"/display/AR/GitHub+Organization+Administration","edit":"/pages/resumedraft.action?draftId=197493858","tinyui":"/x/YoTFCw","self":"https://apps.nrs.gov.bc.ca/int/confluence/rest/api/content/197493858"},"_expandable":{"container":"/rest/api/space/AR","metadata":"","operations":"","children":"/rest/api/content/197493858/child","restrictions":"/rest/api/content/197493858/restriction/byOperation","history":"/rest/api/content/197493858/history","ancestors":"","version":"","descendants":"/rest/api/content/197493858/descendant","space":"/rest/api/space/AR"}}
+{"id":"197493858","type":"page","status":"current","title":"GitHub Organization Administration","body":{"storage":{"value":"<table class=\"wrapped\"><colgroup class=\"\"><col class=\"\" /><col class=\"\" /></colgroup><tbody class=\"\"><tr class=\"\"><th>Status</th><td><div class=\"content-wrapper\"><p>Document</p></div></td></tr><tr class=\"\"><th>Stakeholders</th><td>NRIDS Architecture, FDS</td></tr><tr class=\"\"><th>Description</th><td>The purpose of this page is to outline practices when managing GitHub Org Administration</td></tr><tr class=\"\"><th>Outcome</th><td>Consistent point of reference for onboarding new product teams into the NRM's.</td></tr><tr class=\"\"><th>Owner</th><td>NRIDS Architecture, FDS</td></tr></tbody></table><p><br /></p><p><ac:structured-macro ac:name=\"toc\" ac:schema-version=\"1\" ac:macro-id=\"cc403257-373b-434d-a248-048d9d8bbe8c\" /></p><p><br /></p><h1>Participants</h1><ul><li>Administrators<ul><li>Application Delivery Team</li><li>with support of:<ul><li>1Team</li><li>Derek Roberts</li><li>Om Mishra</li><li>engagement/communication specialists</li><li>security specialists</li></ul></li></ul></li><li>Audience<ul><li>developers</li><li>designers</li><li>devops specialists</li><li>product owners</li><li>internal staff</li></ul></li></ul><ul><li>Advisors – OCIO, Jeff Card, Adam Dewey, Michelle Douville</li></ul><p><br /></p><h1>Costs</h1><ul><li>NRIDS will proceed with a Github Teams License for the BCGOV-NR tenancy <a href=\"https://github.com/bcgov-nr\">https://github.com/bcgov-nr</a></li><li>NRIDS Architecture will continue to engage with OCIOs Platform Services team on their negotiations with Github Enterprise.</li><li>Currently, February 2024, there are less than <ac:inline-comment-marker ac:ref=\"cdde44bb-b669-4f0c-849c-c58161e728e4\">30 participants</ac:inline-comment-marker> in the tenancy and include developers, vendors and internal staff of Team Epsilon, 1Team, DBAs, Application Deliveries, AOT and CGI.</li><li><a href=\"https://github.com/pricing\"><ac:inline-comment-marker ac:ref=\"59447600-6970-42e7-a8e9-5084cc5682e0\">https://github.com/pricing</ac:inline-comment-marker></a></li></ul><p style=\"margin-left: 40.0px;\"><ac:image ac:thumbnail=\"true\" ac:height=\"250\"><ri:attachment ri:filename=\"image-2024-2-28_16-16-9-1.png\" /></ac:image></p><p style=\"margin-left: 40.0px;\"><br /></p><h1>Components of Github Organization Administration</h1><ul><li><h2>Organization Structure &amp; Access Control</h2></li></ul><p style=\"margin-left: 80.0px;\">Organization Structure</p><p style=\"margin-left: 80.0px;\">   - Define a clear organizational structure with teams based on projects or functions.</p><p style=\"margin-left: 80.0px;\">   - Assign <ac:inline-comment-marker ac:ref=\"ee075b6c-e3cc-4844-93d7-3e12f42e5313\">appropriate permissions</ac:inline-comment-marker> to teams and members to control access.</p><p style=\"margin-left: 80.0px;\">Access Control</p><p style=\"margin-left: 80.0px;\">   - Regularly review and update <ac:inline-comment-marker ac:ref=\"0d5f2052-1087-488d-a82b-98b3f22a6fb5\">access permissions</ac:inline-comment-marker>.</p><p style=\"margin-left: 80.0px;\">   - Implement branch protection rules to safeguard critical branches.</p><p style=\"margin-left: 80.0px;\">License Management</p><p style=\"margin-left: 80.0px;\">    - <ac:inline-comment-marker ac:ref=\"e6e79868-dbc4-465b-94a4-c8fce99e6029\">Clearly specify and manage licenses for each repository.</ac:inline-comment-marker></p><p style=\"margin-left: 80.0px;\">    - <ac:inline-comment-marker ac:ref=\"77fad3d2-7c61-4121-b05d-d30bf887a16e\">Regularly review and update licenses as needed.</ac:inline-comment-marker></p><p style=\"margin-left: 80.0px;\"><br /></p><ul><li><h2>Repository Management</h2></li></ul><p style=\"margin-left: 80.0px;\">Repositories and Branching</p><p style=\"margin-left: 80.0px;\">   - <ac:inline-comment-marker ac:ref=\"d7961ca8-e44a-461d-a6a7-6b7d134198e1\">Create repositories for each project or component.</ac:inline-comment-marker></p><p style=\"margin-left: 80.0px;\">   - Establish a branching strategy (e.g., Gitflow) for a structured development process.</p><p style=\"margin-left: 80.0px;\">   - The authority to create BCGOV-C repos will remain with OCIO.</p><p style=\"margin-left: 80.0px;\">Issue Tracking</p><p style=\"margin-left: 80.0px;\">   - Utilize <ac:inline-comment-marker ac:ref=\"80977daf-38f9-429e-abdd-f1ffe27158f4\">GitHub Issues</ac:inline-comment-marker> for tracking tasks, bugs, and enhancements.</p><p style=\"margin-left: 80.0px;\">   - Establish labeling conventions for better categorization.</p><p style=\"margin-left: 80.0px;\">Backups and Recovery</p><p style=\"margin-left: 80.0px;\">    - Regularly back up repositories and related data.</p><p style=\"margin-left: 80.0px;\">    - Establish a recovery plan in case of accidental data loss or compromise.</p><p style=\"margin-left: 80.0px;\"><br /></p><ul><li><h2>Code Review Process &amp; Security</h2></li></ul><p style=\"margin-left: 80.0px;\">Code Review Process</p><p style=\"margin-left: 80.0px;\">   -  Implement a code review process to maintain code quality.</p><p style=\"margin-left: 80.0px;\">   - Require reviews before merging, and use pull request templates.</p><p style=\"margin-left: 80.0px;\">Security Measures</p><p style=\"margin-left: 80.0px;\">   - Regularly scan code for vulnerabilities using GitHub code scanning.</p><p style=\"margin-left: 80.0px;\">   - Implement Dependabot for automated dependency updates.</p><p style=\"margin-left: 80.0px;\"><br /></p><ul><li><h2>Automation and CI/CD</h2><p>   - Set up continuous integration and continuous deployment (CI/CD) pipelines.</p><p>   - Use GitHub Actions or other CI/CD tools to automate testing and deployment processes.</p></li><li><h2>Documentation, Collaboration &amp; Community</h2></li></ul><p style=\"margin-left: 80.0px;\">Documentation</p><p style=\"margin-left: 80.0px;\">   - Maintain comprehensive README files for each repository.</p><p style=\"margin-left: 80.0px;\">   - Utilize GitHub Wiki for extensive documentation on larger projects.</p><p style=\"margin-left: 80.0px;\">Collaboration and Communication</p><p style=\"margin-left: 80.0px;\">   - Encourage collaboration through discussion in issues and pull requests.</p><p style=\"margin-left: 80.0px;\">   - Use GitHub Discussions for broader conversations within the organization.</p><p style=\"margin-left: 80.0px;\">Training and Onboarding</p><p style=\"margin-left: 80.0px;\">    - Provide training sessions for new members on GitHub workflows.</p><p style=\"margin-left: 80.0px;\">    - Maintain a detailed onboarding guide for new contributors.</p><p style=\"margin-left: 80.0px;\">Community Guidelines</p><p style=\"margin-left: 80.0px;\">    - Establish and communicate community guidelines for contributors.</p><p style=\"margin-left: 80.0px;\">    - Enforce a code of conduct to ensure a positive and inclusive environment.</p><p style=\"margin-left: 80.0px;\"><br /></p><ul><li><h2>Monitoring and Auditing</h2></li></ul><p style=\"margin-left: 80.0px;\">    - Use GitHub Insights to monitor repository activity and contributions.</p><p style=\"margin-left: 80.0px;\">    - Analyze metrics to identify areas for improvement in development processes.</p><p style=\"margin-left: 80.0px;\">Regular Audits</p><p style=\"margin-left: 80.0px;\">    - Conduct periodic audits of repositories, permissions, and workflows.</p><p style=\"margin-left: 80.0px;\">    - Address any issues or improvements identified during audits.</p><p style=\"margin-left: 80.0px;\">Ie. Script a monthly mail out to Github Team administrators to review team memberships they own.</p><p style=\"margin-left: 80.0px;\">Ie. Script compliance to metadata standards (readme/pubcode) </p><p style=\"margin-left: 80.0px;\"><br /></p><h1>References</h1><p><a href=\"https://stackify.com/managing-teams-github/\">https://stackify.com/managing-teams-github/</a></p><p><a href=\"https://bcgov.sharepoint.com/:b:/t/03678/EYd__CQ_OflDiaukjBDrYp8BsnA5RXqqQEde9IVQR_qM8w?e=HjAJaY\">GitHub in BC Government - RC1.pdf</a></p><p><a class=\"\" href=\"https://developer.gov.bc.ca/docs/default/component/bc-developer-guide/use-github-in-bcgov/github-enterprise-user-licenses-bc-government/\">https://developer.gov.bc.ca/docs/default/component/bc-developer-guide/use-github-in-bcgov</a></p><p><br /></p>","representation":"storage","_expandable":{"content":"/rest/api/content/197493858"}},"_expandable":{"editor":"","view":"","export_view":"","styled_view":"","anonymous_export_view":""}},"extensions":{"position":"none"},"_links":{"webui":"/display/AR/GitHub+Organization+Administration","edit":"/pages/resumedraft.action?draftId=197493858","tinyui":"/x/YoTFCw","self":"https://apps.nrs.gov.bc.ca/int/confluence/rest/api/content/197493858"},"_expandable":{"container":"/rest/api/space/AR","metadata":"","operations":"","children":"/rest/api/content/197493858/child","restrictions":"/rest/api/content/197493858/restriction/byOperation","history":"/rest/api/content/197493858/history","ancestors":"","version":"","descendants":"/rest/api/content/197493858/descendant","space":"/rest/api/space/AR"}}