Deployed 52ec86f to dev with MkDocs 1.5.3 and mike 1.1.2

bakdata · Oct 26, 2023 · 598e5ac · 598e5ac
1 parent e12a3f5
commit 598e5ac
Show file tree

Hide file tree

Showing 62 changed files with 3,854 additions and 1,207 deletions.
diff --git a/dev/404.html b/dev/404.html
@@ -157,7 +157,7 @@
     <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.4.2 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
   </div>
   <div class="md-source__repository">
-    KPOps
+    GitHub
   </div>
 </a>
       </div>
@@ -274,7 +274,7 @@
     <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.4.2 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
   </div>
   <div class="md-source__repository">
-    KPOps
+    GitHub
   </div>
 </a>
     </div>
@@ -1063,6 +1063,8 @@
 
 
 
+
+
 
 
 
@@ -1113,6 +1115,26 @@
 
 
 
+
+
+
+
+
+    <li class="md-nav__item">
+      <a href="/kpops/dev/user/migration-guide/v2-v3/" class="md-nav__link">
+
+
+  <span class="md-ellipsis">
+    Migrate from v2 to v3
+  </span>
+
+
+      </a>
+    </li>
+
+
+
+
           </ul>
         </nav>
 
@@ -1315,11 +1337,11 @@
 
 
     <li class="md-nav__item">
-      <a href="/kpops/dev/developer/style/" class="md-nav__link">
+      <a href="/kpops/dev/developer/formatting/" class="md-nav__link">
 
 
   <span class="md-ellipsis">
-    Style
+    Formatting
   </span>
 
 

diff --git a/dev/developer/auto-generation/index.html b/dev/developer/auto-generation/index.html
@@ -14,7 +14,7 @@
         <link rel="prev" href="../../user/references/ci-integration/github-actions/">
 
 
-        <link rel="next" href="../style/">
+        <link rel="next" href="../formatting/">
 
 
       <link rel="icon" href="../../assets/images/favicon.png">
@@ -179,7 +179,7 @@
     <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.4.2 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
   </div>
   <div class="md-source__repository">
-    KPOps
+    GitHub
   </div>
 </a>
       </div>
@@ -298,7 +298,7 @@
     <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.4.2 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
   </div>
   <div class="md-source__repository">
-    KPOps
+    GitHub
   </div>
 </a>
     </div>
@@ -1087,6 +1087,8 @@
 
 
 
+
+
 
 
 
@@ -1137,6 +1139,26 @@
 
 
 
+
+
+
+
+
+    <li class="md-nav__item">
+      <a href="../../user/migration-guide/v2-v3/" class="md-nav__link">
+
+
+  <span class="md-ellipsis">
+    Migrate from v2 to v3
+  </span>
+
+
+      </a>
+    </li>
+
+
+
+
           </ul>
         </nav>
 
@@ -1448,11 +1470,11 @@
 
 
     <li class="md-nav__item">
-      <a href="../style/" class="md-nav__link">
+      <a href="../formatting/" class="md-nav__link">
 
 
   <span class="md-ellipsis">
-    Style
+    Formatting
   </span>
 
 
@@ -1588,7 +1610,7 @@ <h4 id="variables"><a href="https://github.com/bakdata/kpops/tree/main/docs/docs
 <ul>
 <li><code>cli_env_vars.env</code> -- All CLI environment variables in a <code>dotenv</code> file.</li>
 <li><code>cli_env_vars.md</code> -- All CLI environment variables in a table.</li>
-<li><code>config_env_vars.env</code> -- Almost all pipeline config environment variables in a <code>dotenv</code> file. The script checks for each field in <a href="https://github.com/bakdata/kpops/blob/main/kpops/cli/pipeline_config.py"><code>PipelineConfig</code></a> whether it has an <code>env</code> attribute defined. The script is currently unable to visit the classes of fields like <code>topic_name_config</code>, hence any environment variables defined there would remain unknown to it.</li>
+<li><code>config_env_vars.env</code> -- Almost all pipeline config environment variables in a <code>dotenv</code> file. The script checks for each field in <a href="https://github.com/bakdata/kpops/blob/main/kpops/cli/kpops_config.py"><code>KpopsConfig</code></a> whether it has an <code>env</code> attribute defined. The script is currently unable to visit the classes of fields like <code>topic_name_config</code>, hence any environment variables defined there would remain unknown to it.</li>
 <li><code>config_env_vars.env</code> -- Almost all pipeline config environment variables in a table.</li>
 <li><code>variable_substitution.yaml</code> -- A copy of <code>./tests/pipeline/resources/component-type-substitution/pipeline.yaml</code> used as an example of substitution.</li>
 </ul>

diff --git a/dev/developer/style/index.html → dev/developer/formatting/index.html b/dev/developer/style/index.html → dev/developer/formatting/index.html
@@ -8,7 +8,7 @@
 
 
 
-        <link rel="canonical" href="https://bakdata.github.io/kpops/dev/developer/style/">
+        <link rel="canonical" href="https://bakdata.github.io/kpops/dev/developer/formatting/">
 
 
         <link rel="prev" href="../auto-generation/">
@@ -20,7 +20,7 @@
 
 
 
-        <title>Style - KPOps</title>
+        <title>Formatting - KPOps</title>
 
 
 
@@ -78,7 +78,7 @@
     <div data-md-component="skip">
 
 
-        <a href="#style" class="md-skip">
+        <a href="#formatting" class="md-skip">
           Skip to content
         </a>
 
@@ -116,7 +116,7 @@
         <div class="md-header__topic" data-md-component="header-topic">
           <span class="md-ellipsis">
 
-              Style
+              Formatting
 
           </span>
         </div>
@@ -177,7 +177,7 @@
     <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.4.2 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
   </div>
   <div class="md-source__repository">
-    KPOps
+    GitHub
   </div>
 </a>
       </div>
@@ -296,7 +296,7 @@
     <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.4.2 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
   </div>
   <div class="md-source__repository">
-    KPOps
+    GitHub
   </div>
 </a>
     </div>
@@ -1085,6 +1085,8 @@
 
 
 
+
+
 
 
 
@@ -1135,6 +1137,26 @@
 
 
 
+
+
+
+
+
+    <li class="md-nav__item">
+      <a href="../../user/migration-guide/v2-v3/" class="md-nav__link">
+
+
+  <span class="md-ellipsis">
+    Migrate from v2 to v3
+  </span>
+
+
+      </a>
+    </li>
+
+
+
+
           </ul>
         </nav>
 
@@ -1352,7 +1374,7 @@
 
 
   <span class="md-ellipsis">
-    Style
+    Formatting
   </span>
 
 
@@ -1363,7 +1385,7 @@
 
 
   <span class="md-ellipsis">
-    Style
+    Formatting
   </span>
 
 
@@ -1384,33 +1406,6 @@
     </label>
     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
 
-        <li class="md-nav__item">
-  <a href="#python" class="md-nav__link">
-    Python
-  </a>
-
-    <nav class="md-nav" aria-label="Python">
-      <ul class="md-nav__list">
-
-          <li class="md-nav__item">
-  <a href="#configuration" class="md-nav__link">
-    Configuration
-  </a>
-
-</li>
-
-          <li class="md-nav__item">
-  <a href="#editor-integration" class="md-nav__link">
-    Editor integration
-  </a>
-
-</li>
-
-      </ul>
-    </nav>
-
-</li>
-
         <li class="md-nav__item">
   <a href="#markdown" class="md-nav__link">
     Markdown
@@ -1460,33 +1455,6 @@
     </label>
     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
 
-        <li class="md-nav__item">
-  <a href="#python" class="md-nav__link">
-    Python
-  </a>
-
-    <nav class="md-nav" aria-label="Python">
-      <ul class="md-nav__list">
-
-          <li class="md-nav__item">
-  <a href="#configuration" class="md-nav__link">
-    Configuration
-  </a>
-
-</li>
-
-          <li class="md-nav__item">
-  <a href="#editor-integration" class="md-nav__link">
-    Editor integration
-  </a>
-
-</li>
-
-      </ul>
-    </nav>
-
-</li>
-
         <li class="md-nav__item">
   <a href="#markdown" class="md-nav__link">
     Markdown
@@ -1512,17 +1480,7 @@
 
 
 
-<h1 id="style">Style<a class="headerlink" href="#style" title="Permanent link">&para;</a></h1>
-<h2 id="python">Python<a class="headerlink" href="#python" title="Permanent link">&para;</a></h2>
-<p>To ensure a consistent Python code style, we use <a href="https://docs.astral.sh/ruff/">Ruff</a> for both linting and formatting.</p>
-<h3 id="configuration">Configuration<a class="headerlink" href="#configuration" title="Permanent link">&para;</a></h3>
-<p>Our configuration can be found in <a href="https://github.com/bakdata/kpops">KPOps</a>' top-level <code>pyproject.toml</code>.</p>
-<h3 id="editor-integration">Editor integration<a class="headerlink" href="#editor-integration" title="Permanent link">&para;</a></h3>
-<p>Below are listed existing Ruff plugins/extensions for some of the most popular python IDEs. If you cannot find your Editor of choices or you want something more custom, <a href="https://github.com/astral-sh/ruff-lsp"><code>ruff-lsp</code></a> enables Ruff to be used in any editor that supports the LSP</p>
-<ul>
-<li><a href="https://marketplace.visualstudio.com/items?itemName=charliermarsh.ruff">VSCode</a></li>
-<li><a href="https://plugins.jetbrains.com/plugin/20574-ruff">PyCharm</a></li>
-</ul>
+<h1 id="formatting">Formatting<a class="headerlink" href="#formatting" title="Permanent link">&para;</a></h1>
 <h2 id="markdown">Markdown<a class="headerlink" href="#markdown" title="Permanent link">&para;</a></h2>
 <p>To ensure a consistent markdown style, we use <a href="https://dprint.dev">dprint</a> to check and reformat.</p>
 <div class="language-shell highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-1">1</a></span></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-0-1"><a id="__codelineno-0-1" name="__codelineno-0-1"></a>dprint<span class="w"> </span>fmt