Updated pages for d6e5535

RedHatInsights · Feb 27, 2024 · a9ee4fc · a9ee4fc
1 parent e609cf2
commit a9ee4fc
Show file tree

Hide file tree

Showing 39 changed files with 168 additions and 73 deletions.
diff --git a/docs/404.html b/docs/404.html
@@ -53,7 +53,7 @@
 <div class="nav-panel-explore is-active" data-panel="explore">
   <ul class="components">
     <li class="component">
-      <a class="title" href="/clowder/clowder/dev/index.html">Clowder</a>
+      <div class="title"><a href="/clowder/clowder/dev/index.html">Clowder</a></div>
       <ul class="versions">
         <li class="version is-latest">
           <a href="/clowder/clowder/dev/index.html">dev</a>

diff --git a/docs/clowder/dev/README.html b/docs/clowder/dev/README.html
@@ -163,7 +163,7 @@ <h3 class="title"><a href="index.html">Clowder</a></h3>
   </div>
   <ul class="components">
     <li class="component is-current">
-      <a class="title" href="index.html">Clowder</a>
+      <div class="title"><a href="index.html">Clowder</a></div>
       <ul class="versions">
         <li class="version is-current is-latest">
           <a href="index.html">dev</a>

diff --git a/docs/clowder/dev/api_reference.html b/docs/clowder/dev/api_reference.html
@@ -163,7 +163,7 @@ <h3 class="title"><a href="index.html">Clowder</a></h3>
   </div>
   <ul class="components">
     <li class="component is-current">
-      <a class="title" href="index.html">Clowder</a>
+      <div class="title"><a href="index.html">Clowder</a></div>
       <ul class="versions">
         <li class="version is-current is-latest">
           <a href="index.html">dev</a>

diff --git a/docs/clowder/dev/clowder-design.html b/docs/clowder/dev/clowder-design.html
@@ -163,7 +163,7 @@ <h3 class="title"><a href="index.html">Clowder</a></h3>
   </div>
   <ul class="components">
     <li class="component is-current">
-      <a class="title" href="index.html">Clowder</a>
+      <div class="title"><a href="index.html">Clowder</a></div>
       <ul class="versions">
         <li class="version is-current is-latest">
           <a href="index.html">dev</a>

diff --git a/docs/clowder/dev/contributing.html b/docs/clowder/dev/contributing.html
@@ -163,7 +163,7 @@ <h3 class="title"><a href="index.html">Clowder</a></h3>
   </div>
   <ul class="components">
     <li class="component is-current">
-      <a class="title" href="index.html">Clowder</a>
+      <div class="title"><a href="index.html">Clowder</a></div>
       <ul class="versions">
         <li class="version is-current is-latest">
           <a href="index.html">dev</a>
@@ -438,6 +438,101 @@ <h3 id="_caching_resources"><a class="anchor" href="#_caching_resources"></a>Cac
 </div>
 </div>
 <div class="sect1">
+<h2 id="_commits"><a class="anchor" href="#_commits"></a>Commits</h2>
+<div class="sectionbody">
+<div class="paragraph">
+<p>We are currently testing <a href="https://www.conventionalcommits.org">Conventional Commits</a> as a mandatory
+step in the pipeline. This requires that each commit to the repo be formatted in the following way:</p>
+</div>
+<div class="listingblock">
+<div class="content">
+<pre class="highlightjs highlight"><code class="language-text hljs" data-lang="text">&lt;purpose&gt;(&lt;scope&gt;): &lt;original commit message&gt;
+
+Original multi line commit message
+* with items
+* in a list</code></pre>
+</div>
+</div>
+<div class="paragraph">
+<p>An example of this would be:</p>
+</div>
+<div class="listingblock">
+<div class="content">
+<pre class="highlightjs highlight"><code class="language-text hljs" data-lang="text">ci(lint): Adds conventional commits
+
+* Adds conventional commits pipeline
+* Updates documentation for the contribution to describe the addition of conventional commits</code></pre>
+</div>
+</div>
+<div class="paragraph">
+<p>It is fine to squash things down into smaller commits - you don&#8217;t have to have separate commits for everything you add, however, if you do this you <strong>MUST</strong> use the <code>!</code> flag appropriately, and it is highly suggested that you use the most significant <code>purpose</code> to help describe your change. For example, a change to a provider that adds a new feature and adds a test and documentation could be done as three commits with <code>feat:</code>, <code>test:</code>, <code>docs:</code>, but we will accept a single commit that uses <code>feat:</code> because the most significant work in this case is the introduction of a new feature.</p>
+</div>
+<div class="sect2">
+<h3 id="_purposes"><a class="anchor" href="#_purposes"></a>Purposes</h3>
+<div class="paragraph">
+<p>Please refer to the <a href="https://www.conventionalcommits.org">Conventional Commits</a> website for more information. As a quick reference we strongly suggest using the following values for <code>purpose</code>:</p>
+</div>
+<div class="ulist">
+<ul>
+<li>
+<p><code>fix</code>: For a bug fix</p>
+</li>
+<li>
+<p><code>feat</code>: For a new feature</p>
+</li>
+<li>
+<p><code>build</code>: For anything related to the building of containers</p>
+</li>
+<li>
+<p><code>chore</code>: For any maintenance task</p>
+</li>
+<li>
+<p><code>ci</code>: For anything related to the CI testing pipeline</p>
+</li>
+<li>
+<p><code>docs</code>: For anything related to documentation</p>
+</li>
+<li>
+<p><code>style</code>: For a stylisitic change, usually to adhere to a guideline</p>
+</li>
+<li>
+<p><code>refactor</code>: For any improvements to code structure</p>
+</li>
+<li>
+<p><code>perf</code>: For performance enhancements to code flow</p>
+</li>
+<li>
+<p><code>test</code>: For any changes to tests</p>
+</li>
+</ul>
+</div>
+<div class="paragraph">
+<p>Using a <code>!</code> after the <code>purpose/scope</code> denotes a breaking change in the context of Clowder, this should be used whenever the API for either the Clowd* CRD resources, as well as any change to the <code>cdappconfig.json</code> spec. An example of a breaing change is shown below:</p>
+</div>
+<div class="listingblock">
+<div class="content">
+<pre class="highlightjs highlight"><code class="language-text hljs" data-lang="text">chore(crd)!: Removes old web field value
+
+* Removes the old web field</code></pre>
+</div>
+</div>
+</div>
+<div class="sect2">
+<h3 id="_scopes"><a class="anchor" href="#_scopes"></a>Scopes</h3>
+<div class="paragraph">
+<p><code>scopes</code> are entirely optional, but using them to indicate changes to providers within clowder would be greatly appreciated. An example is shown below:</p>
+</div>
+<div class="listingblock">
+<div class="content">
+<pre class="highlightjs highlight"><code class="language-text hljs" data-lang="text">feat(database)!: Adds new mode for database provider
+
+* Adds MSSQL mode for Clowder</code></pre>
+</div>
+</div>
+</div>
+</div>
+</div>
+<div class="sect1">
 <h2 id="_pull_request_flow"><a class="anchor" href="#_pull_request_flow"></a>Pull Request Flow</h2>
 <div class="sectionbody">
 <div class="paragraph">

diff --git a/docs/clowder/dev/crc-guide.html b/docs/clowder/dev/crc-guide.html
@@ -163,7 +163,7 @@ <h3 class="title"><a href="index.html">Clowder</a></h3>
   </div>
   <ul class="components">
     <li class="component is-current">
-      <a class="title" href="index.html">Clowder</a>
+      <div class="title"><a href="index.html">Clowder</a></div>
       <ul class="versions">
         <li class="version is-current is-latest">
           <a href="index.html">dev</a>

diff --git a/docs/clowder/dev/developer-guide.html b/docs/clowder/dev/developer-guide.html
@@ -163,7 +163,7 @@ <h3 class="title"><a href="index.html">Clowder</a></h3>
   </div>
   <ul class="components">
     <li class="component is-current">
-      <a class="title" href="index.html">Clowder</a>
+      <div class="title"><a href="index.html">Clowder</a></div>
       <ul class="versions">
         <li class="version is-current is-latest">
           <a href="index.html">dev</a>

diff --git a/docs/clowder/dev/faq.html b/docs/clowder/dev/faq.html
@@ -163,7 +163,7 @@ <h3 class="title"><a href="index.html">Clowder</a></h3>
   </div>
   <ul class="components">
     <li class="component is-current">
-      <a class="title" href="index.html">Clowder</a>
+      <div class="title"><a href="index.html">Clowder</a></div>
       <ul class="versions">
         <li class="version is-current is-latest">
           <a href="index.html">dev</a>

diff --git a/docs/clowder/dev/index.html b/docs/clowder/dev/index.html
@@ -163,7 +163,7 @@ <h3 class="title"><a href="index.html">Clowder</a></h3>
   </div>
   <ul class="components">
     <li class="component is-current">
-      <a class="title" href="index.html">Clowder</a>
+      <div class="title"><a href="index.html">Clowder</a></div>
       <ul class="versions">
         <li class="version is-current is-latest">
           <a href="index.html">dev</a>

diff --git a/docs/clowder/dev/learn-more.html b/docs/clowder/dev/learn-more.html
@@ -163,7 +163,7 @@ <h3 class="title"><a href="index.html">Clowder</a></h3>
   </div>
   <ul class="components">
     <li class="component is-current">
-      <a class="title" href="index.html">Clowder</a>
+      <div class="title"><a href="index.html">Clowder</a></div>
       <ul class="versions">
         <li class="version is-current is-latest">
           <a href="index.html">dev</a>

diff --git a/docs/clowder/dev/macos.html b/docs/clowder/dev/macos.html
@@ -163,7 +163,7 @@ <h3 class="title"><a href="index.html">Clowder</a></h3>
   </div>
   <ul class="components">
     <li class="component is-current">
-      <a class="title" href="index.html">Clowder</a>
+      <div class="title"><a href="index.html">Clowder</a></div>
       <ul class="versions">
         <li class="version is-current is-latest">
           <a href="index.html">dev</a>

diff --git a/docs/clowder/dev/migration/checklist.html b/docs/clowder/dev/migration/checklist.html
@@ -163,7 +163,7 @@ <h3 class="title"><a href="../index.html">Clowder</a></h3>
   </div>
   <ul class="components">
     <li class="component is-current">
-      <a class="title" href="../index.html">Clowder</a>
+      <div class="title"><a href="../index.html">Clowder</a></div>
       <ul class="versions">
         <li class="version is-current is-latest">
           <a href="../index.html">dev</a>

diff --git a/docs/clowder/dev/migration/index.html b/docs/clowder/dev/migration/index.html
@@ -163,7 +163,7 @@ <h3 class="title"><a href="../index.html">Clowder</a></h3>
   </div>
   <ul class="components">
     <li class="component is-current">
-      <a class="title" href="../index.html">Clowder</a>
+      <div class="title"><a href="../index.html">Clowder</a></div>
       <ul class="versions">
         <li class="version is-current is-latest">
           <a href="../index.html">dev</a>

diff --git a/docs/clowder/dev/migration/migration.html b/docs/clowder/dev/migration/migration.html
@@ -163,7 +163,7 @@ <h3 class="title"><a href="../index.html">Clowder</a></h3>
   </div>
   <ul class="components">
     <li class="component is-current">
-      <a class="title" href="../index.html">Clowder</a>
+      <div class="title"><a href="../index.html">Clowder</a></div>
       <ul class="versions">
         <li class="version is-current is-latest">
           <a href="../index.html">dev</a>

diff --git a/docs/clowder/dev/providers/confighash.html b/docs/clowder/dev/providers/confighash.html
@@ -163,7 +163,7 @@ <h3 class="title"><a href="../index.html">Clowder</a></h3>
   </div>
   <ul class="components">
     <li class="component is-current">
-      <a class="title" href="../index.html">Clowder</a>
+      <div class="title"><a href="../index.html">Clowder</a></div>
       <ul class="versions">
         <li class="version is-current is-latest">
           <a href="../index.html">dev</a>

diff --git a/docs/clowder/dev/providers/cronjob.html b/docs/clowder/dev/providers/cronjob.html
@@ -163,7 +163,7 @@ <h3 class="title"><a href="../index.html">Clowder</a></h3>
   </div>
   <ul class="components">
     <li class="component is-current">
-      <a class="title" href="../index.html">Clowder</a>
+      <div class="title"><a href="../index.html">Clowder</a></div>
       <ul class="versions">
         <li class="version is-current is-latest">
           <a href="../index.html">dev</a>

diff --git a/docs/clowder/dev/providers/database.html b/docs/clowder/dev/providers/database.html
@@ -163,7 +163,7 @@ <h3 class="title"><a href="../index.html">Clowder</a></h3>
   </div>
   <ul class="components">
     <li class="component is-current">
-      <a class="title" href="../index.html">Clowder</a>
+      <div class="title"><a href="../index.html">Clowder</a></div>
       <ul class="versions">
         <li class="version is-current is-latest">
           <a href="../index.html">dev</a>

diff --git a/docs/clowder/dev/providers/dependencies.html b/docs/clowder/dev/providers/dependencies.html
@@ -163,7 +163,7 @@ <h3 class="title"><a href="../index.html">Clowder</a></h3>
   </div>
   <ul class="components">
     <li class="component is-current">
-      <a class="title" href="../index.html">Clowder</a>
+      <div class="title"><a href="../index.html">Clowder</a></div>
       <ul class="versions">
         <li class="version is-current is-latest">
           <a href="../index.html">dev</a>

diff --git a/docs/clowder/dev/providers/deployment.html b/docs/clowder/dev/providers/deployment.html
@@ -163,7 +163,7 @@ <h3 class="title"><a href="../index.html">Clowder</a></h3>
   </div>
   <ul class="components">
     <li class="component is-current">
-      <a class="title" href="../index.html">Clowder</a>
+      <div class="title"><a href="../index.html">Clowder</a></div>
       <ul class="versions">
         <li class="version is-current is-latest">
           <a href="../index.html">dev</a>

diff --git a/docs/clowder/dev/providers/featureflags.html b/docs/clowder/dev/providers/featureflags.html
@@ -163,7 +163,7 @@ <h3 class="title"><a href="../index.html">Clowder</a></h3>
   </div>
   <ul class="components">
     <li class="component is-current">
-      <a class="title" href="../index.html">Clowder</a>
+      <div class="title"><a href="../index.html">Clowder</a></div>
       <ul class="versions">
         <li class="version is-current is-latest">
           <a href="../index.html">dev</a>

diff --git a/docs/clowder/dev/providers/index.html b/docs/clowder/dev/providers/index.html
@@ -163,7 +163,7 @@ <h3 class="title"><a href="../index.html">Clowder</a></h3>
   </div>
   <ul class="components">
     <li class="component is-current">
-      <a class="title" href="../index.html">Clowder</a>
+      <div class="title"><a href="../index.html">Clowder</a></div>
       <ul class="versions">
         <li class="version is-current is-latest">
           <a href="../index.html">dev</a>

diff --git a/docs/clowder/dev/providers/inmemorydb.html b/docs/clowder/dev/providers/inmemorydb.html
@@ -163,7 +163,7 @@ <h3 class="title"><a href="../index.html">Clowder</a></h3>
   </div>
   <ul class="components">
     <li class="component is-current">
-      <a class="title" href="../index.html">Clowder</a>
+      <div class="title"><a href="../index.html">Clowder</a></div>
       <ul class="versions">
         <li class="version is-current is-latest">
           <a href="../index.html">dev</a>

diff --git a/docs/clowder/dev/providers/kafka.html b/docs/clowder/dev/providers/kafka.html
@@ -163,7 +163,7 @@ <h3 class="title"><a href="../index.html">Clowder</a></h3>
   </div>
   <ul class="components">
     <li class="component is-current">
-      <a class="title" href="../index.html">Clowder</a>
+      <div class="title"><a href="../index.html">Clowder</a></div>
       <ul class="versions">
         <li class="version is-current is-latest">
           <a href="../index.html">dev</a>

diff --git a/docs/clowder/dev/providers/logging.html b/docs/clowder/dev/providers/logging.html
@@ -163,7 +163,7 @@ <h3 class="title"><a href="../index.html">Clowder</a></h3>
   </div>
   <ul class="components">
     <li class="component is-current">
-      <a class="title" href="../index.html">Clowder</a>
+      <div class="title"><a href="../index.html">Clowder</a></div>
       <ul class="versions">
         <li class="version is-current is-latest">
           <a href="../index.html">dev</a>

diff --git a/docs/clowder/dev/providers/metrics.html b/docs/clowder/dev/providers/metrics.html
@@ -163,7 +163,7 @@ <h3 class="title"><a href="../index.html">Clowder</a></h3>
   </div>
   <ul class="components">
     <li class="component is-current">
-      <a class="title" href="../index.html">Clowder</a>
+      <div class="title"><a href="../index.html">Clowder</a></div>
       <ul class="versions">
         <li class="version is-current is-latest">
           <a href="../index.html">dev</a>

diff --git a/docs/clowder/dev/providers/objectstore.html b/docs/clowder/dev/providers/objectstore.html
@@ -163,7 +163,7 @@ <h3 class="title"><a href="../index.html">Clowder</a></h3>
   </div>
   <ul class="components">
     <li class="component is-current">
-      <a class="title" href="../index.html">Clowder</a>
+      <div class="title"><a href="../index.html">Clowder</a></div>
       <ul class="versions">
         <li class="version is-current is-latest">
           <a href="../index.html">dev</a>

diff --git a/docs/clowder/dev/providers/serviceaccount.html b/docs/clowder/dev/providers/serviceaccount.html
@@ -163,7 +163,7 @@ <h3 class="title"><a href="../index.html">Clowder</a></h3>
   </div>
   <ul class="components">
     <li class="component is-current">
-      <a class="title" href="../index.html">Clowder</a>
+      <div class="title"><a href="../index.html">Clowder</a></div>
       <ul class="versions">
         <li class="version is-current is-latest">
           <a href="../index.html">dev</a>

diff --git a/docs/clowder/dev/providers/servicemesh.html b/docs/clowder/dev/providers/servicemesh.html
@@ -163,7 +163,7 @@ <h3 class="title"><a href="../index.html">Clowder</a></h3>
   </div>
   <ul class="components">
     <li class="component is-current">
-      <a class="title" href="../index.html">Clowder</a>
+      <div class="title"><a href="../index.html">Clowder</a></div>
       <ul class="versions">
         <li class="version is-current is-latest">
           <a href="../index.html">dev</a>

diff --git a/docs/clowder/dev/providers/sidecars.html b/docs/clowder/dev/providers/sidecars.html
@@ -163,7 +163,7 @@ <h3 class="title"><a href="../index.html">Clowder</a></h3>
   </div>
   <ul class="components">
     <li class="component is-current">
-      <a class="title" href="../index.html">Clowder</a>
+      <div class="title"><a href="../index.html">Clowder</a></div>
       <ul class="versions">
         <li class="version is-current is-latest">
           <a href="../index.html">dev</a>

diff --git a/docs/clowder/dev/providers/web.html b/docs/clowder/dev/providers/web.html
@@ -163,7 +163,7 @@ <h3 class="title"><a href="../index.html">Clowder</a></h3>
   </div>
   <ul class="components">
     <li class="component is-current">
-      <a class="title" href="../index.html">Clowder</a>
+      <div class="title"><a href="../index.html">Clowder</a></div>
       <ul class="versions">
         <li class="version is-current is-latest">
           <a href="../index.html">dev</a>

diff --git a/docs/clowder/dev/sop.html b/docs/clowder/dev/sop.html
@@ -163,7 +163,7 @@ <h3 class="title"><a href="index.html">Clowder</a></h3>
   </div>
   <ul class="components">
     <li class="component is-current">
-      <a class="title" href="index.html">Clowder</a>
+      <div class="title"><a href="index.html">Clowder</a></div>
       <ul class="versions">
         <li class="version is-current is-latest">
           <a href="index.html">dev</a>

diff --git a/docs/clowder/dev/usage/app-workflow.html b/docs/clowder/dev/usage/app-workflow.html
@@ -163,7 +163,7 @@ <h3 class="title"><a href="../index.html">Clowder</a></h3>
   </div>
   <ul class="components">
     <li class="component is-current">
-      <a class="title" href="../index.html">Clowder</a>
+      <div class="title"><a href="../index.html">Clowder</a></div>
       <ul class="versions">
         <li class="version is-current is-latest">
           <a href="../index.html">dev</a>

diff --git a/docs/clowder/dev/usage/getting-started.html b/docs/clowder/dev/usage/getting-started.html
@@ -163,7 +163,7 @@ <h3 class="title"><a href="../index.html">Clowder</a></h3>
   </div>
   <ul class="components">
     <li class="component is-current">
-      <a class="title" href="../index.html">Clowder</a>
+      <div class="title"><a href="../index.html">Clowder</a></div>
       <ul class="versions">
         <li class="version is-current is-latest">
           <a href="../index.html">dev</a>