Built site for gh-pages

.nojekyll

@@ -1 +1 @@
-ad28cf8f
+fd7883bd

index.html

@@ -135,6 +135,7 @@ <h2 id="toc-title">On this page</h2>
   <ul class="collapse">
   <li><a href="#sec-glossary" id="toc-sec-glossary" class="nav-link" data-scroll-target="#sec-glossary"><span class="header-section-number">4.1</span> Glossary</a></li>
   <li><a href="#sec-what-can-be-shared" id="toc-sec-what-can-be-shared" class="nav-link" data-scroll-target="#sec-what-can-be-shared"><span class="header-section-number">4.2</span> What Content Can Be Shared on GitHub?</a></li>
+  <li><a href="#sec-data" id="toc-sec-data" class="nav-link" data-scroll-target="#sec-data"><span class="header-section-number">4.3</span> Sharing data: Alternatives to Git Large File Storage</a></li>
   </ul></li>
   <li><a href="#sec-account-guidelines" id="toc-sec-account-guidelines" class="nav-link" data-scroll-target="#sec-account-guidelines"><span class="header-section-number">5</span> Account Guidelines</a>
   <ul class="collapse">
@@ -304,6 +305,15 @@ <h3 data-number="4.2" class="anchored" data-anchor-id="sec-what-can-be-shared"><
 <p>Generally, content on GitHub is limited to NOAA’s scientific products as defined in the <a href="https://sciencecouncil.noaa.gov/Scientific-Integrity-Commons/SIC-Integrity-Policy">NOAA Scientific Integrity Policy</a>. This policy defines such products as “The results of scientific activities including the analysis, synthesis, compilation, or translation of scientific information and data into electronic and hardcopy formats for the use of NOAA, the Department of Commerce, or the Nation. These products include, but are not limited to, experimental and operational models, forecasts, graphics, and verbal and written communications of all kinds relating to scientific activities, including NOAA social media accounts.”</p>
 <p>The open source nature of GitHub allows content to be available for other developers to build upon or contribute to via <a href="https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/about-forks">fork</a>, <a href="https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository">clone</a>, or <a href="https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests">pull request</a>. Embracing this open source workflow facilitates open review by allowing others to comment and offer solutions for open issues, improving bug reports by allowing users to see source code, and providing the full history of the project changes (i.e., version control, usually Git). Note, <a href="https://opensource.org/osd">“open source”</a> is not equivalent to making content publicly accessible. The level of visibility of a repository to the general public is a separate decision and is project dependent.</p>
 </section>
+<section id="sec-data" class="level3" data-number="4.3">
+<h3 data-number="4.3" class="anchored" data-anchor-id="sec-data"><span class="header-section-number">4.3</span> Sharing data: Alternatives to Git Large File Storage</h3>
+<p>Oftentimes, data also needs to be shared with code. Small datasets can be directly committed to a repository in a variety of formats. However, when datasets are large can be more challenging. GitHub <a href="https://docs.github.com/en/enterprise-cloud@latest/repositories/working-with-files/managing-large-files/about-large-files-on-github">restricts pushing of files large than 100 MiB from the command line</a>. There is GitHub <a href="https://docs.github.com/en/repositories/working-with-files/managing-large-files/about-git-large-file-storage">Large File Storage</a> for files up to 5 GB on GitHub Enterprise Cloud, but in practice, staff have found some difficulties with Large File Storage. Issues include:</p>
+<ol type="1">
+<li>It is difficult to delete a file once it has been committed, even if the version history is rewritten to remove the file. GitHub suggests <a href="https://docs.github.com/en/repositories/working-with-files/managing-large-files/removing-files-from-git-large-file-storage#git-lfs-objects-in-your-repository">deleting the repository</a>, which may not be possible for established repositories.</li>
+<li>There are limits to the the included space for Large File Storage with GitHub accounts.</li>
+</ol>
+<p>Because of these issues, other ways of sharing data may be preferable. Some options include: - <a href="https://www.ncei.noaa.gov/archive">archiving data at NCEI</a>. - storing data in an on-premise database (contact your office’s IT department for more information about what is available to you). - sharing public data via the <a href="https://www.noaa.gov/information-technology/open-data-dissemination">NOAA Open Data Desemination program (NODD)</a>. For example, some <a href="https://console.cloud.google.com/marketplace/product/noaa-public/afsc-odp">Alaska Fisheries Science Center data</a> is shared through the NODD, which provides access to cloud storage. - for large files as part of a release, the <a href="https://docs.ropensci.org/piggyback/index.html">piggyback R package</a>. - storing and sharing datasets via Google Drive.</p>
+</section>
 </section>
 <section id="sec-account-guidelines" class="level2" data-number="5">
 <h2 data-number="5" class="anchored" data-anchor-id="sec-account-guidelines"><span class="header-section-number">5</span> Account Guidelines</h2>

search.json

@@ -32,7 +32,7 @@
     "href": "index.html#sec-guidelines",
     "title": "GitHub and Git",
     "section": "4 Guidelines for Use of GitHub at NOAA Fisheries",
-    "text": "4 Guidelines for Use of GitHub at NOAA Fisheries\nThe information here is intended to provide employees and affiliates of NOAA Fisheries (NMFS) with practical guidance and “best practices” for how to use GitHub. NOAA allows use of GitHub to share code and content in the spirit of collaboration and open government (2017 GitHub memo) and to support NOAA’s obligation to share code developed with federal funds (NAO 201-118). NOAA has a strong history of scientific collaboration, coordination, and close engagement with other government partners, non-government organizations, academic institutions, international colleagues, and other members of the scientific research community.\n\n4.1 Glossary\nNOAA Branded Product - NOAA Branded Organizations are created by a science center, regional office, division, or program for its official products. These GitHub organizations are distinguished by clear branding that indicates that the repositories are official agency products.\nNon-Enterprise GitHub Organization (org) - Organizations are shared accounts where members of the org can collaborate across many repositories at once. Owners and administrators can manage member access to the organization’s data and projects with sophisticated security and administrative features. Org in this context is not related to organizations on an org chart. It is more like a managed folder of folders.\nRepository - A repository is hosted online and contains all of a project’s files and each file’s revision history.\n\n\n4.2 What Content Can Be Shared on GitHub?\nGenerally, content on GitHub is limited to NOAA’s scientific products as defined in the NOAA Scientific Integrity Policy. This policy defines such products as “The results of scientific activities including the analysis, synthesis, compilation, or translation of scientific information and data into electronic and hardcopy formats for the use of NOAA, the Department of Commerce, or the Nation. These products include, but are not limited to, experimental and operational models, forecasts, graphics, and verbal and written communications of all kinds relating to scientific activities, including NOAA social media accounts.”\nThe open source nature of GitHub allows content to be available for other developers to build upon or contribute to via fork, clone, or pull request. Embracing this open source workflow facilitates open review by allowing others to comment and offer solutions for open issues, improving bug reports by allowing users to see source code, and providing the full history of the project changes (i.e., version control, usually Git). Note, “open source” is not equivalent to making content publicly accessible. The level of visibility of a repository to the general public is a separate decision and is project dependent."
+    "text": "4 Guidelines for Use of GitHub at NOAA Fisheries\nThe information here is intended to provide employees and affiliates of NOAA Fisheries (NMFS) with practical guidance and “best practices” for how to use GitHub. NOAA allows use of GitHub to share code and content in the spirit of collaboration and open government (2017 GitHub memo) and to support NOAA’s obligation to share code developed with federal funds (NAO 201-118). NOAA has a strong history of scientific collaboration, coordination, and close engagement with other government partners, non-government organizations, academic institutions, international colleagues, and other members of the scientific research community.\n\n4.1 Glossary\nNOAA Branded Product - NOAA Branded Organizations are created by a science center, regional office, division, or program for its official products. These GitHub organizations are distinguished by clear branding that indicates that the repositories are official agency products.\nNon-Enterprise GitHub Organization (org) - Organizations are shared accounts where members of the org can collaborate across many repositories at once. Owners and administrators can manage member access to the organization’s data and projects with sophisticated security and administrative features. Org in this context is not related to organizations on an org chart. It is more like a managed folder of folders.\nRepository - A repository is hosted online and contains all of a project’s files and each file’s revision history.\n\n\n4.2 What Content Can Be Shared on GitHub?\nGenerally, content on GitHub is limited to NOAA’s scientific products as defined in the NOAA Scientific Integrity Policy. This policy defines such products as “The results of scientific activities including the analysis, synthesis, compilation, or translation of scientific information and data into electronic and hardcopy formats for the use of NOAA, the Department of Commerce, or the Nation. These products include, but are not limited to, experimental and operational models, forecasts, graphics, and verbal and written communications of all kinds relating to scientific activities, including NOAA social media accounts.”\nThe open source nature of GitHub allows content to be available for other developers to build upon or contribute to via fork, clone, or pull request. Embracing this open source workflow facilitates open review by allowing others to comment and offer solutions for open issues, improving bug reports by allowing users to see source code, and providing the full history of the project changes (i.e., version control, usually Git). Note, “open source” is not equivalent to making content publicly accessible. The level of visibility of a repository to the general public is a separate decision and is project dependent.\n\n\n4.3 Sharing data: Alternatives to Git Large File Storage\nOftentimes, data also needs to be shared with code. Small datasets can be directly committed to a repository in a variety of formats. However, when datasets are large can be more challenging. GitHub restricts pushing of files large than 100 MiB from the command line. There is GitHub Large File Storage for files up to 5 GB on GitHub Enterprise Cloud, but in practice, staff have found some difficulties with Large File Storage. Issues include:\n\nIt is difficult to delete a file once it has been committed, even if the version history is rewritten to remove the file. GitHub suggests deleting the repository, which may not be possible for established repositories.\nThere are limits to the the included space for Large File Storage with GitHub accounts.\n\nBecause of these issues, other ways of sharing data may be preferable. Some options include: - archiving data at NCEI. - storing data in an on-premise database (contact your office’s IT department for more information about what is available to you). - sharing public data via the NOAA Open Data Desemination program (NODD). For example, some Alaska Fisheries Science Center data is shared through the NODD, which provides access to cloud storage. - for large files as part of a release, the piggyback R package. - storing and sharing datasets via Google Drive."
   },
   {
     "objectID": "index.html#sec-account-guidelines",

sitemap.xml

@@ -2,6 +2,6 @@
 <urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
   <url>
     <loc>https://nmfs-opensci.github.io/GitHub-Guide/index.html</loc>
-    <lastmod>2025-01-14T18:26:22.357Z</lastmod>
+    <lastmod>2025-01-17T23:49:00.916Z</lastmod>
   </url>
 </urlset>