Merge pull request #1161 from kapicorp/update-docs

Update docs

.gitignore

@@ -3,6 +3,8 @@ __pycache__/
 *.py[cod]
 *$py.class
 
+.gitpod.yml
+
 # C extensions
 *.so
 *.h

docs/FAQ.md

@@ -5,7 +5,7 @@ comments: true
 
 ## Why do I need **Kapitan**?
 
-See [Why do I need **Kapitan**?](pages/blog/2022-12-04.md#why-do-i-need-kapitan)
+See [Why do I need **Kapitan**?](pages/blog/posts/2022-12-04.md#why-do-i-need-kapitan)
 
 ## Ask your question
 

docs/README.md

@@ -12,7 +12,7 @@ Empower your team to make changes to your infrastructure whilst maintaining full
 * :fontawesome-brands-slack: Join the community [`#kapitan`](https://kubernetes.slack.com/archives/C981W2HD3)
 * :fontawesome-brands-github: Help us grow: [give us a star](https://github.com/kapicorp/kapitan/stargazers) or even better [sponsor our project](pages/contribute/sponsor/)
 
-## [Why do I need **Kapitan**?](pages/blog/2022-12-04.md#why-do-i-need-kapitan) 
+## [Why do I need **Kapitan**?](pages/blog/posts/2022-12-04.md#why-do-i-need-kapitan) 
 
 ## [Video Tutorials to get started](https://www.youtube.com/@kapitandev)
 

docs/pages/blog/index.md

@@ -0,0 +1,2 @@
+# Blog
+

docs/pages/blog/2022-12-04.md → docs/pages/blog/posts/2022-12-04.md

@@ -2,7 +2,7 @@
 author: Alessandro De Maria
 author_gh_user: ademariag
 read_time: 10m
-publish_date: 04/12/2022
+date: 2022-12-04
 ---
 
 # :kapitan-logo: **5 Years** of **Kapitan**
@@ -17,6 +17,8 @@ Let this first blog post from a revamped website be a promise to our community o
 
 And let's start with a simple question: Why do you even need **Kapitan**?
 
+<!-- more -->
+
 !!! info ":kapitan-logo: Credits  :heart:"
         In reality Kapitan's heatbeat started about 9 months earlier at DeepMind Health, created by [**Ricardo Amaro**](https://github.com/ramaro) with the help of some of my amazing team: in no particular order [Adrian Chifor](https://github.com/adrianchifor), [Paul S](https://github.com/uberspot) and [Luis Buriola](https://github.com/gburiola). It was then kindly released to the community by Google/DeepMind and is has so been improved thanks to more than [50 contributors](https://github.com/kapicorp/kapitan/graphs/contributors).
 

docs/pages/blog/2023-01-16.md → docs/pages/blog/posts/2023-01-16.md

@@ -2,7 +2,7 @@
 author: Alessandro De Maria
 author_gh_user: ademariag
 read_time: 10m
-publish_date: 16/01/2023
+date: 2022-12-04
 ---
 
 # :kapitan-logo: New **Kapitan** release  v0.31.0
@@ -15,4 +15,4 @@ Head over our [release page](https://github.com/kapicorp/kapitan/releases/tag/v0
 
 If you missed it, have a look at our latest blog post here [5 years of Kapitan](2022-12-04.md)
 
-Please help us by visiting our [Sponsor Kapitan](../contribute/sponsor.md) page.
+Please help us by visiting our [Sponsor Kapitan](../../contribute/sponsor.md) page.

docs/pages/blog/2023-06-01.md → docs/pages/blog/posts/2023-06-01.md

@@ -1,10 +1,9 @@
 ---
-author: Luis Buriola
-author_gh_user: gburiola
-read_time: 2m
-publish_date: 01/06/2023
+author: Alessandro De Maria
+author_gh_user: ademariag
+read_time: 10m
+date: 2022-12-04
 ---
-
 # :kapitan-logo: New **Kapitan** release  v0.32.0
 
 The **Kapicorp** team is happy to to announce a new release of **Kapitan**.
@@ -13,4 +12,4 @@ This release contains loads of improvements for the past 6 months, the majority
 
 Head over our [release page](https://github.com/kapicorp/kapitan/releases/tag/v0.32.0) on GitHub for a full list of features and contributors.
 
-Please help us by visiting our [Sponsor Kapitan](../contribute/sponsor.md) page.
+Please help us by visiting our [Sponsor Kapitan](../../contribute/sponsor.md) page.

docs/pages/blog/2023-08-27.md → docs/pages/blog/posts/2023-08-27.md

@@ -2,7 +2,7 @@
 author: Alessandro De Maria
 author_gh_user: ademariag
 read_time: 10m
-publish_date: 27/08/2023
+date: 2023-08-27
 ---
 
 # :kapitan-logo: **Deploying Keda with Kapitan**
@@ -23,6 +23,8 @@ This tutorial will show you how to configure kapitan to:
 
 The content of this tutorial is already available on the [`kapitan-reference`](https://github.com/kapicorp/kapitan-reference)
 
+<!-- more -->
+
 ## Deploying KEDA
 
 ### Define parameters

docs/pages/blog/2024-02-12.md → docs/pages/blog/posts/2024-02-12.md

@@ -2,7 +2,7 @@
 author: Luis Buriola
 author_gh_user: gburiola
 read_time: 2m
-publish_date: 12/02/2024
+date: 2024-02-12
 ---
 
 # :kapitan-logo: New **Kapitan** release  v0.33.1
@@ -13,4 +13,4 @@ This release contains loads of improvements for the past 8 months, the majority
 
 Head over our [release page](https://github.com/kapicorp/kapitan/releases/tag/v0.33.1) on GitHub for a full list of features and contributors.
 
-Please help us by visiting our [Sponsor Kapitan](../contribute/sponsor.md) page.
+Please help us by visiting our [Sponsor Kapitan](../../contribute/sponsor.md) page.

mkdocs.yml

@@ -4,16 +4,18 @@ site_name: "Kapitan: Keep your ship together"
 site_url: "https://kapitan.dev"
 strict: true
 plugins:
+  - blog:
+      archive: false
+      blog_dir: pages/blog
+      post_url_date_format: dd/MM/yyyy
   - tags:
       tags_file: tags.md
   - search
-extra_css:
-  - stylesheets/custom.css
 theme:
   name: material
   custom_dir: overrides
-  logo: images/kapitan_logo.png
-  favicon: images/kapitan_logo.png
+  logo: images/logo.min.svg
+  favicon: images/logo.min.svg
   features:
     - announce.dismiss
     - content.code.annotate
@@ -62,22 +64,7 @@ extra:
       link: https://kubernetes.slack.com/archives/C981W2HD3
       name: "#kapitan slack channel"
   analytics:
-    provider: google
-    property: G-5E934SC0R8
-    feedback:
-      title: Was this page helpful?
-      ratings:
-        - icon: material/emoticon-happy-outline
-          name: This page was helpful
-          data: 1
-          note: >-
-            Thanks for your feedback!
-        - icon: material/emoticon-sad-outline
-          name: This page could be improved
-          data: 0
-          note: >-
-            Thanks for your feedback! Help us improve this page by
-            using our <a href="..." target="_blank" rel="noopener">feedback form</a>.
+    provider: custom
 use_directory_urls: true
 nav:
   - Home: README.md
@@ -113,11 +100,7 @@ nav:
           - validate: pages/commands/kapitan_validate.md
           - kapitan dotfile: pages/commands/kapitan_dotfile.md
   - Blog:
-    - 2023:
-      - Kapitan Generators: pages/blog/2023-08-27.md
-      - New Kapitan release: pages/blog/2023-01-16.md
-    - 2022:
-      - 5 years of Kapitan: pages/blog/2022-12-04.md
+    - pages/blog/index.md
   - Support:
       - Ask for support: support.md
       - Related Projects: related.md

overrides/main.html

@@ -1,12 +1,18 @@
 {% extends "base.html" %}
-
 {% block announce %}
 <p>New <strong>kapitan</strong> release <a title="v0.33.1" href="/pages/blog/2024-02-12/">v0.33.1</a> now available!</p>
 {% endblock %}
-
+{% block scripts %}
+  {{ super() }}
+   <!-- Google Tag Manager (noscript) -->
+   <noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-WPN4JBMH"
+    height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
+    <!-- End Google Tag Manager (noscript) -->
+{% endblock %}
 
  {% block content %}
 
+
   <!-- Edit button -->
   {% if page.edit_url %}
   <a
@@ -17,42 +23,5 @@
       {% include ".icons/material/pencil.svg" %}
   </a>
 {% endif %}
-
- {% if not "\x3ch1" in page.content %}
-    <h1>{{ page.title | d(config.site_name, true)}}</h1>
- {% endif %}
-
- <!-- Markdown content -->
- {% if page and page.meta and page.meta.author_gh_user %}
- <aside class="mdx-author">
-     <p>
-     <img src="https://avatars.githubusercontent.com/{{ page.meta.author_gh_user }}" alt="@{{ page.meta.author_gh_user }}">
-     </p>
-     <p>
-     <span>
-     <b>{{ page.meta.author }}</b> · <a href="https://github.com/{{ page.meta.author_gh_user }}">@{{ page.meta.author_gh_user }}</a>
-     </span>
-     <span>
-         <svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" fill="currentColor" class="bi bi-calendar2" viewBox="0 0 16 16">
-             <path d="M3.5 0a.5.5 0 0 1 .5.5V1h8V.5a.5.5 0 0 1 1 0V1h1a2 2 0 0 1 2 2v11a2 2 0 0 1-2 2H2a2 2 0 0 1-2-2V3a2 2 0 0 1 2-2h1V.5a.5.5 0 0 1 .5-.5zM2 2a1 1 0 0 0-1 1v11a1 1 0 0 0 1 1h12a1 1 0 0 0 1-1V3a1 1 0 0 0-1-1H2z"/>
-             <path d="M2.5 4a.5.5 0 0 1 .5-.5h10a.5.5 0 0 1 .5.5v1a.5.5 0 0 1-.5.5H3a.5.5 0 0 1-.5-.5V4z"/>
-         </svg> {{ page.meta.publish_date }} ·
-         <svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" fill="currentColor" class="bi bi-clock" viewBox="0 0 16 16">
-             <path d="M8 3.5a.5.5 0 0 0-1 0V9a.5.5 0 0 0 .252.434l3.5 2a.5.5 0 0 0 .496-.868L8 8.71V3.5z"/>
-             <path d="M8 16A8 8 0 1 0 8 0a8 8 0 0 0 0 16zm7-8A7 7 0 1 1 1 8a7 7 0 0 1 14 0z"/>
-         </svg> {{ page.meta.read_time }} read
-     </span>
-     </p>
- </aside>
- {% endif %}
-    {{ page.content }}
-
-    <!-- Last update of source file -->
-    {% if page and page.meta %}
-        {% if page.meta.git_revision_date_localized or
-            page.meta.revision_date
-        %}
-            {% include "partials/source-file.html" %}
-        {% endif %}
-    {% endif %}
+{{ page.content }}
 {% endblock %}

overrides/partials/integrations/analytics/custom.html

@@ -0,0 +1,7 @@
+<!-- Google Tag Manager -->
+<script>(function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({'gtm.start':
+  new Date().getTime(),event:'gtm.js'});var f=d.getElementsByTagName(s)[0],
+  j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src=
+  'https://www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f);
+  })(window,document,'script','dataLayer','GTM-WPN4JBMH');</script>
+<!-- End Google Tag Manager -->

requirements.docs.txt

@@ -1,5 +1,5 @@
 markdown-include==0.8.1
 mkdocs-material-extensions==1.3.1
-mkdocs-material==9.5.9
+mkdocs-material==9.5.15
 mkdocs==1.5.3
-pymdown-extensions==10.7
+pymdown-extensions==10.7.1