diff --git a/.gitignore b/.gitignore index 4004e5bbb..6b6fa961b 100644 --- a/.gitignore +++ b/.gitignore @@ -3,6 +3,8 @@ __pycache__/ *.py[cod] *$py.class +.gitpod.yml + # C extensions *.so *.h diff --git a/docs/FAQ.md b/docs/FAQ.md index 61e49211d..8d2b7c8dc 100644 --- a/docs/FAQ.md +++ b/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 diff --git a/docs/README.md b/docs/README.md index 52e55d076..442b31243 100644 --- a/docs/README.md +++ b/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) diff --git a/docs/images/logo.min.svg b/docs/images/logo.min.svg new file mode 100644 index 000000000..1502f7cae --- /dev/null +++ b/docs/images/logo.min.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/docs/pages/blog/index.md b/docs/pages/blog/index.md new file mode 100644 index 000000000..c58f16c50 --- /dev/null +++ b/docs/pages/blog/index.md @@ -0,0 +1,2 @@ +# Blog + diff --git a/docs/pages/blog/2022-12-04.md b/docs/pages/blog/posts/2022-12-04.md similarity index 99% rename from docs/pages/blog/2022-12-04.md rename to docs/pages/blog/posts/2022-12-04.md index b010662cd..d78b21edf 100644 --- a/docs/pages/blog/2022-12-04.md +++ b/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**? + + !!! 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). diff --git a/docs/pages/blog/2023-01-16.md b/docs/pages/blog/posts/2023-01-16.md similarity index 85% rename from docs/pages/blog/2023-01-16.md rename to docs/pages/blog/posts/2023-01-16.md index e24bed6ad..fc635681c 100644 --- a/docs/pages/blog/2023-01-16.md +++ b/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. diff --git a/docs/pages/blog/2023-06-01.md b/docs/pages/blog/posts/2023-06-01.md similarity index 70% rename from docs/pages/blog/2023-06-01.md rename to docs/pages/blog/posts/2023-06-01.md index fdd0748ad..16a60f1e0 100644 --- a/docs/pages/blog/2023-06-01.md +++ b/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. diff --git a/docs/pages/blog/2023-08-27.md b/docs/pages/blog/posts/2023-08-27.md similarity index 99% rename from docs/pages/blog/2023-08-27.md rename to docs/pages/blog/posts/2023-08-27.md index ce6a1a0f4..6743e8010 100644 --- a/docs/pages/blog/2023-08-27.md +++ b/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) + + ## Deploying KEDA ### Define parameters diff --git a/docs/pages/blog/2024-02-12.md b/docs/pages/blog/posts/2024-02-12.md similarity index 81% rename from docs/pages/blog/2024-02-12.md rename to docs/pages/blog/posts/2024-02-12.md index e2c533a32..759de1875 100644 --- a/docs/pages/blog/2024-02-12.md +++ b/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. diff --git a/docs/stylesheets/custom.css b/docs/stylesheets/custom.css deleted file mode 100644 index 4293d8e14..000000000 --- a/docs/stylesheets/custom.css +++ /dev/null @@ -1,27 +0,0 @@ -/* Styles for blog-like features - author avatar & name, posting date, min to read, etc. */ -.md-typeset .mdx-author img { - border-radius: 100%; - height: 2rem; - } - - .md-typeset .mdx-author { - display: flex; - font-size: .68rem; - } - - .md-typeset .mdx-author p>span { - display: block; - } - - p { - display: block; - margin-block-start: 1em; - margin-block-end: 1em; - margin-inline-start: 0px; - margin-inline-end: 0px; - } - - .md-typeset .mdx-author p:first-child { - flex-shrink: 0; - margin-right: .8rem; - } \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml index 04d380bc8..312b6f6c9 100644 --- a/mkdocs.yml +++ b/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 feedback form. + 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 diff --git a/overrides/.icons/kapitan/logo.svg b/overrides/.icons/kapitan/logo.svg index 5ed935756..426380625 100644 --- a/overrides/.icons/kapitan/logo.svg +++ b/overrides/.icons/kapitan/logo.svg @@ -1 +1 @@ - \ No newline at end of file + \ No newline at end of file diff --git a/overrides/main.html b/overrides/main.html index 17f3a41bf..a8d15cdc6 100644 --- a/overrides/main.html +++ b/overrides/main.html @@ -1,12 +1,18 @@ {% extends "base.html" %} - {% block announce %}

New kapitan release v0.33.1 now available!

{% endblock %} - +{% block scripts %} + {{ super() }} + + + +{% endblock %} {% block content %} + {% if page.edit_url %} {% endif %} - - {% if not "\x3ch1" in page.content %} -

{{ page.title | d(config.site_name, true)}}

- {% endif %} - - - {% if page and page.meta and page.meta.author_gh_user %} -
- {% endif %} - {{ page.content }} - - - {% 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 %} \ No newline at end of file diff --git a/overrides/partials/integrations/analytics/custom.html b/overrides/partials/integrations/analytics/custom.html new file mode 100644 index 000000000..363ccf208 --- /dev/null +++ b/overrides/partials/integrations/analytics/custom.html @@ -0,0 +1,7 @@ + + + \ No newline at end of file diff --git a/requirements.docs.txt b/requirements.docs.txt index b7587835b..cb32e8b26 100644 --- a/requirements.docs.txt +++ b/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