Skip to content

Commit

Permalink
Built site for gh-pages
Browse files Browse the repository at this point in the history
  • Loading branch information
actions-user committed Dec 4, 2023
1 parent 3eb9827 commit 17904c0
Show file tree
Hide file tree
Showing 5 changed files with 18 additions and 13 deletions.
2 changes: 1 addition & 1 deletion .nojekyll
Original file line number Diff line number Diff line change
@@ -1 +1 @@
73842e3f
335f990a
23 changes: 14 additions & 9 deletions index.html
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,7 @@ <h2 id="toc-title">On this page</h2>
<li><a href="#turn-on-2-factor-authentication-on-your-account" id="toc-turn-on-2-factor-authentication-on-your-account" class="nav-link" data-scroll-target="#turn-on-2-factor-authentication-on-your-account"><span class="header-section-number">2.2</span> Turn on 2-Factor Authentication on your account</a></li>
<li><a href="#nmfs-github-enterprise-cloud-user-agreement" id="toc-nmfs-github-enterprise-cloud-user-agreement" class="nav-link" data-scroll-target="#nmfs-github-enterprise-cloud-user-agreement"><span class="header-section-number">2.3</span> NMFS GitHub Enterprise Cloud user agreement</a></li>
<li><a href="#request-access-to-nmfs-github-enterprise-cloud" id="toc-request-access-to-nmfs-github-enterprise-cloud" class="nav-link" data-scroll-target="#request-access-to-nmfs-github-enterprise-cloud"><span class="header-section-number">2.4</span> Request access to NMFS GitHub Enterprise Cloud</a></li>
<li><a href="#request-on-boarding-instructions" id="toc-request-on-boarding-instructions" class="nav-link" data-scroll-target="#request-on-boarding-instructions"><span class="header-section-number">2.5</span> Request on-boarding instructions</a></li>
<li><a href="#wait-for-the-organization-invite-and-on-boarding-instructions" id="toc-wait-for-the-organization-invite-and-on-boarding-instructions" class="nav-link" data-scroll-target="#wait-for-the-organization-invite-and-on-boarding-instructions"><span class="header-section-number">2.5</span> Wait for the organization invite and on-boarding instructions</a></li>
</ul></li>
<li><a href="#sec-background" id="toc-sec-background" class="nav-link" data-scroll-target="#sec-background"><span class="header-section-number">3</span> Background</a>
<ul class="collapse">
Expand Down Expand Up @@ -206,7 +206,7 @@ <h2 data-number="2" class="anchored" data-anchor-id="sec-quickstart"><span class
<li>Turn on 2-Factor Authentication on your account.</li>
<li>Download the NMFS GitHub Enterprise Cloud user agreement and have your supervisor sign it</li>
<li>Request access to your offices’ GitHub Enterprise Cloud organization.</li>
<li>Reach out to the GitHub organization admin to request on-boarding instructions.</li>
<li>Watch for an invite to the GitHub organization in your email and on-boarding instructions.</li>
</ol>
<section id="create-a-github-user-account" class="level3" data-number="2.1">
<h3 data-number="2.1" class="anchored" data-anchor-id="create-a-github-user-account"><span class="header-section-number">2.1</span> Create a GitHub user account</h3>
Expand All @@ -229,11 +229,12 @@ <h3 data-number="2.3" class="anchored" data-anchor-id="nmfs-github-enterprise-cl
<section id="request-access-to-nmfs-github-enterprise-cloud" class="level3" data-number="2.4">
<h3 data-number="2.4" class="anchored" data-anchor-id="request-access-to-nmfs-github-enterprise-cloud"><span class="header-section-number">2.4</span> Request access to NMFS GitHub Enterprise Cloud</h3>
<p>Request access to the GitHub organization for your the office where you work and any other GitHub organization that you need access to. Use <a href="https://docs.google.com/forms/d/e/1FAIpQLScvWB-gTtQKlFPdyt3Y_H_oya9EW6Nj-56jsWJsxVdT8RJwHw/viewform">this Google form</a> to request access. You will need to upload your user agreement.</p>
<p>Wait for an email inviting your to become a member of the GitHub organization. Once you accept the invitation, you see that you are listed as a member of the <a href="https://github.com/enterprises/noaa-nmfs">organization</a>.</p>
<p>Wait for an email inviting your to become a member of the GitHub organization. Once you accept the invitation, you see that you are listed as a member of the <a href="https://github.com/enterprises/noaa-nmfs">NMFS GHEC site</a>. Note, you will get a 404 error unless you are a NMFS GHEC member.</p>
</section>
<section id="request-on-boarding-instructions" class="level3" data-number="2.5">
<h3 data-number="2.5" class="anchored" data-anchor-id="request-on-boarding-instructions"><span class="header-section-number">2.5</span> Request on-boarding instructions</h3>
<p>Each NMFS GitHub <a href="https://github.com/enterprises/noaa-nmfs">organization</a> has different on-boarding processes and different processes for creating repositories in the organization. This <a href="https://docs.google.com/spreadsheets/d/1WG4aEFzW2Evjp39Fq12wA4SUW-yDUZs3vYZZ0sTqiAQ/edit?usp=sharing">Google spreadsheet</a> (NOAA internal) shows you the Standard Operating Procedures (SOP) and the admins. Note in most cases, you will need to be added as a member of the GitHub organization to see its SOP.</p>
<section id="wait-for-the-organization-invite-and-on-boarding-instructions" class="level3" data-number="2.5">
<h3 data-number="2.5" class="anchored" data-anchor-id="wait-for-the-organization-invite-and-on-boarding-instructions"><span class="header-section-number">2.5</span> Wait for the organization invite and on-boarding instructions</h3>
<p>Each NMFS GitHub Enterprise organization has different on-boarding processes. This <a href="https://docs.google.com/spreadsheets/d/1WG4aEFzW2Evjp39Fq12wA4SUW-yDUZs3vYZZ0sTqiAQ/edit?usp=sharing">Google spreadsheet</a> (NOAA internal) shows you the Standard Operating Procedures (SOP) and the admins for the GitHub Enterprise organizations.</p>
<p>Be on the look out for an invite to the GitHub Enterprise organization. Accept the invitation and then you will be able to see the <a href="https://github.com/enterprises/noaa-nmfs">NMFS GHEC organizations</a>. Once you are a member of the organization, review its SOP (in this <a href="https://docs.google.com/spreadsheets/d/1WG4aEFzW2Evjp39Fq12wA4SUW-yDUZs3vYZZ0sTqiAQ/edit?usp=sharing">Google spreadsheet</a> (NOAA internal)) for how to proceed. Reach out to your local NMFS GHEC organization admins (in the spreadsheet) if you need help.</p>
</section>
</section>
<section id="sec-background" class="level2" data-number="3">
Expand Down Expand Up @@ -470,21 +471,25 @@ <h3 data-number="9.2" class="anchored" data-anchor-id="sec-disclaimer"><span cla
</section>
<section id="sec-license" class="level3" data-number="9.3">
<h3 data-number="9.3" class="anchored" data-anchor-id="sec-license"><span class="header-section-number">9.3</span> LICENSE Files</h3>
<p>The work of U.S. Government employees is not subject to copyright in the U.S. Thus, you should include an appropriate LICENSE file with your repositories. These are the licenses that are commonly used for government work: Creative Commons Zero v1.0 Universal (CC0 1.0 Universal), GNU General Public License v3.0 (GPL-3), MIT, and Apache 2.0. The CC0 license is used data and content products but it is not an open source license for software. For software, the three most common license are GPL-3, MIT, and Apache 2.0. The NOAA Fisheries Integrated Toolbox prefers the GPL-3 license as it is a strong copy-left license.</p>
<p>To add a LICENSE file to your repository, navigate to the repository on GitHub.com, select “add file,”, select “create new file”, and type LICENSE. You will then see the button in the upper right hand of the page to choose a license file. Additionally, the following statement applies with regards to licensing for any code published in any NOAA repository. This should be included within a <code>LICENSE.md</code> file at the root of each repository. Repositories that are code packages should also add this license addendum to the repository <code>README.md</code>.</p>
<p>The work of U.S. Government employees is not subject to copyright in the U.S. Thus, you should include an appropriate LICENSE and License.md file with your repositories. These are the licenses that are commonly used for government work: Creative Commons Zero v1.0 Universal (CC0 1.0 Universal), GNU General Public License v3.0 (GPL-3), MIT, and Apache 2.0. The CC0 license is used data and content products but not software. For software, the three most common license are GPL-3, MIT, and Apache 2.0. The NOAA Fisheries Integrated Toolbox prefers the GPL-3 license as it is a strong copy-left license.</p>
<p>To add a license to your repository, navigate to the repository on GitHub.com, select “add file,”, select “create new file”, and type <code>License.md</code>. You will then see the button in the upper right hand of the page or a link somewhere to choose a license file. Use the template to choose your license and make the file was not renamed to <code>LICENSE</code>. You want <code>License.md</code> at this step. This file will just have the open source license text.</p>
<p>If the repository is code or a code package, include the software addendum within a <code>LICENSE</code> file at the root of the repository. The addendum should also be added to the repository <code>README.md</code>.</p>
<div class="callout callout-style-default callout-note no-icon callout-titled">
<div class="callout-header d-flex align-content-center">
<div class="callout-icon-container">
<i class="callout-icon no-icon"></i>
</div>
<div class="callout-title-container flex-fill">
LICENSE.md
License
</div>
</div>
<div class="callout-body-container callout-body">
<p>The YourPackageName package as a whole is distributed under <a href="https://www.tldrlegal.com/license/gnu-general-public-license-v3-gpl-3">GNU GENERAL PUBLIC LICENSE version 3</a> (GPL-3).</p>
<p>In addition this software has the following license addendum:</p>
<p>Software code created by U.S. Government employees is not subject to copyright in the United States (17 U.S.C. §105). The United States/Department of Commerce reserves all rights to seek and obtain copyright protection in countries other than the United States for Software authored in its entirety by the Department of Commerce. To this end, the Department of Commerce hereby grants to Recipient a royalty-free, nonexclusive license to use, copy, and create derivative works of the Software outside of the United States.</p>
</div>
</div>
<p>Including the license and addendum in this way will ensure that GitHub displays the license in the repository information and that the open source license is retained with the addendum in case the <code>License.md</code> file is removed.</p>
</section>
</section>
<section id="github-governance-team-and-access-to-github-enterprise-cloud" class="level2" data-number="10">
Expand Down
Binary file modified index.pdf
Binary file not shown.
Loading

0 comments on commit 17904c0

Please sign in to comment.