Built site for gh-pages

uwescience · Apr 10, 2024 · e983dee · e983dee
1 parent 62117e5
commit e983dee
Show file tree

Hide file tree

Showing 14 changed files with 727 additions and 12 deletions.
diff --git a/.nojekyll b/.nojekyll
@@ -1 +1 @@
-13f37698
+7415d552
diff --git a/_tex/index.tex b/_tex/index.tex
@@ -292,6 +292,28 @@ \section{Introduction}\label{introduction}
 have pervaded the current era of open science and team science
 \cite{Baumgartner2023TeamScience, Koch2016TeamScience}.
 
+\section{Challenges for open source data and metadata standards, and
+some
+solutions}\label{challenges-for-open-source-data-and-metadata-standards-and-some-solutions}
+
+\subsection{Too much flexibility, or too
+little}\label{too-much-flexibility-or-too-little}
+
+It's a story as old as time (or at least as old as standards): users
+fail to consider existing standards, or perceive an existing standard as
+not offering enough flexibility to cover some use case, and they embark
+on the development of a new standard \footnote{So old in fact that an
+  oft-cited \href{https://xkcd.com/927/}{XKCD comic} has been devoted to
+  it.}.
+
+Another failure is the mismatch between developers of the standard and
+users.
+
+\subsection{Sustainability}\label{sustainability}
+
+\subsection{The importance of automated
+validation}\label{the-importance-of-automated-validation}
+
 \section{Recommendations}\label{recommendations}
 
 We make the following recommendations:

diff --git a/index.html b/index.html
@@ -102,9 +102,15 @@ <h2 id="toc-title">Table of contents</h2>
   <li><a href="#under-construction" id="toc-under-construction" class="nav-link active" data-scroll-target="#under-construction"><span class="header-section-number">1</span> 🚧 Under construction 🚧</a></li>
   <li><a href="#abstract" id="toc-abstract" class="nav-link" data-scroll-target="#abstract"><span class="header-section-number">2</span> Abstract</a></li>
   <li><a href="#introduction" id="toc-introduction" class="nav-link" data-scroll-target="#introduction"><span class="header-section-number">3</span> Introduction</a></li>
-  <li><a href="#recommendations" id="toc-recommendations" class="nav-link" data-scroll-target="#recommendations"><span class="header-section-number">4</span> Recommendations</a></li>
+  <li><a href="#challenges-for-open-source-data-and-metadata-standards-and-some-solutions" id="toc-challenges-for-open-source-data-and-metadata-standards-and-some-solutions" class="nav-link" data-scroll-target="#challenges-for-open-source-data-and-metadata-standards-and-some-solutions"><span class="header-section-number">4</span> Challenges for open source data and metadata standards, and some solutions</a>
+  <ul class="collapse">
+  <li><a href="#too-much-flexibility-or-too-little" id="toc-too-much-flexibility-or-too-little" class="nav-link" data-scroll-target="#too-much-flexibility-or-too-little"><span class="header-section-number">4.1</span> Too much flexibility, or too little</a></li>
+  <li><a href="#sustainability" id="toc-sustainability" class="nav-link" data-scroll-target="#sustainability"><span class="header-section-number">4.2</span> Sustainability</a></li>
+  <li><a href="#the-importance-of-automated-validation" id="toc-the-importance-of-automated-validation" class="nav-link" data-scroll-target="#the-importance-of-automated-validation"><span class="header-section-number">4.3</span> The importance of automated validation</a></li>
+  </ul></li>
+  <li><a href="#recommendations" id="toc-recommendations" class="nav-link" data-scroll-target="#recommendations"><span class="header-section-number">5</span> Recommendations</a></li>
   </ul>
-<div class="quarto-alternate-notebooks"><h2>Notebooks</h2><ul><li><a href="sections/01-introduction-preview.html"><i class="bi bi-journal-code"></i>Introduction</a></li><li><a href="sections/02-recommendations-preview.html"><i class="bi bi-journal-code"></i>Recommendations</a></li></ul></div></nav>
+<div class="quarto-alternate-notebooks"><h2>Notebooks</h2><ul><li><a href="sections/01-introduction-preview.html"><i class="bi bi-journal-code"></i>Introduction</a></li><li><a href="sections/xx-recommendations-preview.html"><i class="bi bi-journal-code"></i>Recommendations</a></li><li><a href="sections/02-challenges-preview.html"><i class="bi bi-journal-code"></i>Challenges for open source data and metadata standards, and some solutions</a></li></ul></div></nav>
 </div>
 <div id="quarto-margin-sidebar" class="sidebar margin-sidebar">
 </div>
@@ -132,16 +138,36 @@ <h1 data-number="3"><span class="header-section-number">3</span> Introduction</h
 <p>A necessary complement to these technical tools and legal instruments have been a host of practices that define the social interactions communities of OSS developers and users, and structures for governing these communities. While many OSS communities started as projects led by individual founders (so-called benevolent dictators for life, or BDFL; a title first bestowed on the originator of the Python programming language, Guido Van Rossum ), recent years have led to an increased understanding that minimal standards of democratic governance are required in order for OSS communities to develop and flourish. This has led to the adoption of codes of conduct that govern the standards of behavior and communication among project stakeholders. It has also led to the establishment of democratically elected steering councils/committees from among the members and stakeholders of an OSS project’s community.</p>
 <p>It was also within the Python community that an orderly process for community-guided evolution of an open-source software project emerged, through the Python Enhancement Proposal (PEP) mechanism , which lays out how major changes to the software should be proposed, advocated for, and eventually decided on. While these tools, ideas, and practices evolved in developing software, they are readily translated to other domains. For example, OSS notions surrounding IP have given rise to the Creative Commons movement that has expanded these notions to apply to a much wider range of human creative endeavours. Similarly OSS notions regarding collaborative structures have pervaded the current era of open science and team science .</p>
 </section>
-<section id="recommendations" class="level1" data-number="4">
-<h1 data-number="4"><span class="header-section-number">4</span> Recommendations</h1>
+<section id="challenges-for-open-source-data-and-metadata-standards-and-some-solutions" class="level1" data-number="4">
+<h1 data-number="4"><span class="header-section-number">4</span> Challenges for open source data and metadata standards, and some solutions</h1>
+<section id="too-much-flexibility-or-too-little" class="level2" data-number="4.1">
+<h2 data-number="4.1" class="anchored" data-anchor-id="too-much-flexibility-or-too-little"><span class="header-section-number">4.1</span> Too much flexibility, or too little</h2>
+<p>It’s a story as old as time (or at least as old as standards): users fail to consider existing standards, or perceive an existing standard as not offering enough flexibility to cover some use case, and they embark on the development of a new standard <a href="#fn1" class="footnote-ref" id="fnref1" role="doc-noteref"><sup>1</sup></a>.</p>
+<p>Another failure is the mismatch between developers of the standard and users.</p>
+</section>
+<section id="sustainability" class="level2" data-number="4.2">
+<h2 data-number="4.2" class="anchored" data-anchor-id="sustainability"><span class="header-section-number">4.2</span> Sustainability</h2>
+</section>
+<section id="the-importance-of-automated-validation" class="level2" data-number="4.3">
+<h2 data-number="4.3" class="anchored" data-anchor-id="the-importance-of-automated-validation"><span class="header-section-number">4.3</span> The importance of automated validation</h2>
+</section>
+</section>
+<section id="recommendations" class="level1" data-number="5">
+<h1 data-number="5"><span class="header-section-number">5</span> Recommendations</h1>
 <p>We make the following recommendations:</p>
 <ol type="1">
 <li>Training for data stewards and career paths that encourage this role.</li>
 <li>Development of meta-standards or standards-of-standards. These are descriptions of cross-cutting best-practices. These can be used as a basis of the analysis or assessment of an existing standard, or as guidelines to develop new standards.</li>
 </ol>
 </section>
 
-</main>
+
+<div id="quarto-appendix" class="default"><section id="footnotes" class="footnotes footnotes-end-of-document" role="doc-endnotes"><h2 class="anchored quarto-appendix-heading">Footnotes</h2>
+
+<ol>
+<li id="fn1"><p>So old in fact that an oft-cited <a href="https://xkcd.com/927/">XKCD comic</a> has been devoted to it.<a href="#fnref1" class="footnote-back" role="doc-backlink">↩︎</a></p></li>
+</ol>
+</section></div></main>
 <!-- /main column -->
 <script id="quarto-html-after-body" type="application/javascript">
 window.document.addEventListener("DOMContentLoaded", function (event) {

diff --git a/index.pdf b/index.pdf
diff --git a/sections/01-introduction.embed.ipynb b/sections/01-introduction.embed.ipynb
@@ -20,7 +20,7 @@
     "\n",
     "It was also within the Python community that an orderly process for community-guided evolution of an open-source software project emerged, through the Python Enhancement Proposal (PEP) mechanism , which lays out how major changes to the software should be proposed, advocated for, and eventually decided on. While these tools, ideas, and practices evolved in developing software, they are readily translated to other domains. For example, OSS notions surrounding IP have given rise to the Creative Commons movement that has expanded these notions to apply to a much wider range of human creative endeavours. Similarly OSS notions regarding collaborative structures have pervaded the current era of open science and team science ."
    ],
-   "id": "a783f876-fcd4-42c2-8b71-fc995da23397"
+   "id": "ded2924f-f5a9-4e7f-98e2-ef30148ca01a"
   }
  ],
  "nbformat": 4,

diff --git a/sections/01-introduction.out.ipynb b/sections/01-introduction.out.ipynb
@@ -20,7 +20,7 @@
     "\n",
     "It was also within the Python community that an orderly process for community-guided evolution of an open-source software project emerged, through the Python Enhancement Proposal (PEP) mechanism , which lays out how major changes to the software should be proposed, advocated for, and eventually decided on. While these tools, ideas, and practices evolved in developing software, they are readily translated to other domains. For example, OSS notions surrounding IP have given rise to the Creative Commons movement that has expanded these notions to apply to a much wider range of human creative endeavours. Similarly OSS notions regarding collaborative structures have pervaded the current era of open science and team science ."
    ],
-   "id": "8ec18cc3-df91-4182-bc3f-ba2dd77b09ed"
+   "id": "567f66db-abe2-44de-85c2-4592029a03b8"
   }
  ],
  "nbformat": 4,