Skip to content

Commit

Permalink
Fix typo and Quarto template URL
Browse files Browse the repository at this point in the history
  • Loading branch information
MattGrossi-NOAA authored May 8, 2024
1 parent 447c8e2 commit 756d967
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions _docs/about.md
Original file line number Diff line number Diff line change
Expand Up @@ -132,7 +132,7 @@ Several features were prioritized when selecting a platform for SEFSC documentat



Google Docs, though straightforward to create and widely used across NOAA, present too many challenges. File ownership is a perpetual problem, with the original author often retaining ownership and files getting lost in staffing changes. Without preserving documents’ URLs, sharing access permissions, and transferring ownership when needed, these files often get lost or are not known to exist by new staff. There is also a tendency for documents to perpetually stay in “draft” version, which casts doubt on the accuracy of the content and whether or not a final version exists. A far better solution is one that is connected to GitHub where the model code itself is hosted and maintained. One option is [GitHub Wikis](https://docs.github.com/en/communities/documenting-your-project-with-wikis/about-wikis){:target="_blank" rel="noopener"}, which can be created for any repository and have been widely used by [NOAA Integrated Ocean Observing System (IOOS)](https://ioos.noaa.gov/){:target="_blank" rel="noopener"} programs, such as the [original National Glider Data Assembly Center documentation](https://github.com/ioos/ioosngdac/wiki/DAC-Documentation){:target="_blank" rel="noopener"} page. Yet these Wikis offer limited version control and customization aside from the actual content. [GitHub Pages](https://pages.github.com/){:target="_blank" rel="noopener"}, a service that allows a project website to be freely hosted for any repository, offers a more comprehensive assortment of options and flexibilities including customizable themes that can be tailored to agency visual branding, the ability to control this theme in one repository and use it across any number of documents, full version control, and the option of creating a [template repository](https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-template-repository){:target="_blank" rel="noopener"} that can be easily duplicated and integrated into new projects. **This project uses a Jekyll theme to create a documentation website and utilizes GitHub Pages for hosting with full version control.** (For an alternative solution using Quarto, Python, and GitHub Pages, see the [SEFSC Quarto Decumentation Theme](https://mattgrossi-noaa.github.io/SEFSC-documentation-quarto-python-skeleton/){:target="_blank" rel="noopener"}.)
Google Docs, though straightforward to create and widely used across NOAA, present too many challenges. File ownership is a perpetual problem, with the original author often retaining ownership and files getting lost in staffing changes. Without preserving documents’ URLs, sharing access permissions, and transferring ownership when needed, these files often get lost or are not known to exist by new staff. There is also a tendency for documents to perpetually stay in “draft” version, which casts doubt on the accuracy of the content and whether or not a final version exists. A far better solution is one that is connected to GitHub where the model code itself is hosted and maintained. One option is [GitHub Wikis](https://docs.github.com/en/communities/documenting-your-project-with-wikis/about-wikis){:target="_blank" rel="noopener"}, which can be created for any repository and have been widely used by [NOAA Integrated Ocean Observing System (IOOS)](https://ioos.noaa.gov/){:target="_blank" rel="noopener"} programs, such as the [original National Glider Data Assembly Center documentation](https://github.com/ioos/ioosngdac/wiki/DAC-Documentation){:target="_blank" rel="noopener"} page. Yet these Wikis offer limited version control and customization aside from the actual content. [GitHub Pages](https://pages.github.com/){:target="_blank" rel="noopener"}, a service that allows a project website to be freely hosted for any repository, offers a more comprehensive assortment of options and flexibilities including customizable themes that can be tailored to agency visual branding, the ability to control this theme in one repository and use it across any number of documents, full version control, and the option of creating a [template repository](https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-template-repository){:target="_blank" rel="noopener"} that can be easily duplicated and integrated into new projects. **This project uses a Jekyll theme to create a documentation website and utilizes GitHub Pages for hosting with full version control.** (For an alternative solution using Quarto, Python, and GitHub Pages, see the [SEFSC Quarto Documentation Theme](https://mattgrossi-noaa.github.io/SEFSC-documentation-quarto-skeleton/){:target="_blank" rel="noopener"}.)

# Custom SEFSC Theme for GitHub Pages Documentation Sites

Expand Down Expand Up @@ -641,4 +641,4 @@ We hope this page provides guidance for others within NOAA interested in creatin
<br>
<p style="text-align:left; font-size:large;">
<a style="text-decoration:none;" href="{{ site.url }}{{ site.baseurl }}/howto.html"> &#9664; <b>Creating the SEFSC theme and template</b> </a>
</p>
</p>

0 comments on commit 756d967

Please sign in to comment.