Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feat/add helm docs #67

Open
wants to merge 62 commits into
base: feat/add-docusaurus
Choose a base branch
from
Open

Feat/add helm docs #67

wants to merge 62 commits into from

Conversation

JTaeuber
Copy link
Member

@JTaeuber JTaeuber commented Nov 4, 2024

Motivation

Adding documentation for the Helm Chart

Refers to #38

Blocked by #80 and #69

Changes

  • fixed pre-commit email
  • refactored values.yaml
  • added documentation pages for the helm chart
  • added global links file

Tests done

Ran the site locally

TODO

Make links to arguments and environment variable pages.

@JTaeuber JTaeuber added the documentation Improvements or additions to documentation label Nov 4, 2024
@jonathan-mayer jonathan-mayer linked an issue Jan 7, 2025 that may be closed by this pull request
This was referenced Jan 8, 2025
@jonathan-mayer jonathan-mayer added the blocked A PR which is blocked by other Issues/PRs label Jan 8, 2025
@jonathan-mayer
Copy link
Member

added label blocked because it is now relying on feat/add-content-to-site to be merged, since it builds on it

* feat: implement title case check

* fix file name

* Squashed commit of the following:

commit 77b2231
Author: jonathan-mayer <[email protected]>
Date:   Tue Jan 7 07:56:43 2025 +0100

    fix: old link refs

commit afef94f
Author: jonathan-mayer <[email protected]>
Date:   Fri Jan 3 08:11:44 2025 +0100

    fix: pre commit workflow maybe fr this time

commit e933534
Author: jonathan-mayer <[email protected]>
Date:   Fri Jan 3 08:03:42 2025 +0100

    fix: pre commit workflow

commit 51600e6
Author: jonathan-mayer <[email protected]>
Date:   Fri Jan 3 07:52:50 2025 +0100

    fix: pre commit workflow

commit d1d41eb
Author: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Date:   Fri Jan 3 06:47:07 2025 +0000

    chore: automatically push pre-commit changes

commit b1f6626
Merge: f71ee5b 682a174
Author: jonathan-mayer <[email protected]>
Date:   Fri Jan 3 07:42:27 2025 +0100

    Merge branch 'feat/add-docusaurus' into feat/add-content-to-site

commit f71ee5b
Author: jonathan-mayer <[email protected]>
Date:   Fri Jan 3 07:39:11 2025 +0100

    fix: eslint hook

commit 6631880
Author: jonathan-mayer <[email protected]>
Date:   Fri Jan 3 07:37:56 2025 +0100

    chore: bump deps

commit 8643fff
Author: jonathan-mayer <[email protected]>
Date:   Fri Jan 3 07:29:12 2025 +0100

    docs: migrating from pykubedownscaler

commit 3373c7b
Author: jonathan-mayer <[email protected]>
Date:   Fri Jan 3 07:18:12 2025 +0100

    fix: eslint

commit 42b724e
Author: jonathan-mayer <[email protected]>
Date:   Thu Jan 2 11:22:00 2025 +0100

    docs: types

commit f0d4b5e
Author: jonathan-mayer <[email protected]>
Date:   Thu Jan 2 10:19:02 2025 +0100

    docs: values and layers

commit 2039efb
Author: jonathan-mayer <[email protected]>
Date:   Thu Jan 2 08:06:31 2025 +0100

    docs: workload types

commit f8e9e41
Author: jonathan-mayer <[email protected]>
Date:   Fri Dec 13 08:29:06 2024 +0100

    feat: highlight line

commit 32d1a71
Author: jonathan-mayer <[email protected]>
Date:   Fri Dec 13 08:01:57 2024 +0100

    docs: update markdown links docs

commit 95a1826
Author: jonathan-mayer <[email protected]>
Date:   Fri Dec 13 06:56:57 2024 +0100

    docs: add link to workflow

commit ffba97d
Author: jonathan-mayer <[email protected]>
Date:   Fri Dec 13 06:51:55 2024 +0100

    refactor: preprocessor to remark plugin

commit 5c90aae
Author: jonathan-mayer <[email protected]>
Date:   Thu Dec 12 09:36:37 2024 +0100

    feat: sw away from global md links

commit eaf8c04
Author: jonathan-mayer <[email protected]>
Date:   Mon Dec 9 14:02:11 2024 +0100

    docs: add documentation for user level configuration layers

commit 6fc3686
Author: jonathan-mayer <[email protected]>
Date:   Tue Dec 3 08:35:00 2024 +0100

    feat: add best practices for developing website

commit d585c38
Author: jonathan-mayer <[email protected]>
Date:   Mon Nov 25 15:22:42 2024 +0100

    feat: markdown links

commit d032665
Author: Jonathan Mayer <[email protected]>
Date:   Sun Nov 24 19:47:33 2024 +0000

    feat: added yaml, json, js, ts, jsx, tsx to file extensions checked by prevent todo comments hook

commit 00b4aad
Author: Jonathan Mayer <[email protected]>
Date:   Sun Nov 24 19:43:43 2024 +0000

    fix: prevent todo comments hook

commit 2617e9e
Author: Jonathan Mayer <[email protected]>
Date:   Sun Nov 24 19:33:09 2024 +0000

    docs: added docs for adding/changing pages and categories

commit 82272e8
Author: Jonathan Mayer <[email protected]>
Date:   Sun Nov 24 19:02:10 2024 +0000

    feat: update pre commit config to better match relevent files

commit 443482d
Author: Jonathan Mayer <[email protected]>
Date:   Sun Nov 24 14:35:49 2024 +0000

    docs: add workflow documentation

commit 1575bfd
Author: Jonathan Mayer <[email protected]>
Date:   Sun Nov 24 13:12:49 2024 +0000

    docs: fix indefinite article misuse

commit 0ee5140
Author: Jonathan Mayer <[email protected]>
Date:   Fri Nov 22 19:51:31 2024 +0000

    feat: add mdx highlighing

commit 9d3634f
Author: jonathan-mayer <[email protected]>
Date:   Tue Nov 19 21:52:28 2024 +0100

    feat: a lot

commit 10a9b8b
Author: jonathan-mayer <[email protected]>
Date:   Mon Nov 4 08:12:21 2024 +0100

    fix: made regexList match whole string

commit da0fca8
Author: jonathan-mayer <[email protected]>
Date:   Mon Nov 4 08:12:14 2024 +0100

    fix: update pre commit to not fail because of markdown headings

commit 3cbd3e2
Author: jonathan-mayer <[email protected]>
Date:   Mon Nov 4 08:01:09 2024 +0100

    docs: update readme to refer to the website

commit fc4e17c
Author: jonathan-mayer <[email protected]>
Date:   Mon Nov 4 08:00:14 2024 +0100

    docs: fix spelling mistakes in docs

commit 4a0f7cf
Author: jonathan-mayer <[email protected]>
Date:   Mon Nov 4 07:59:07 2024 +0100

    feat: update pre commit config to match new files

commit 54ce506
Author: jonathan-mayer <[email protected]>
Date:   Mon Nov 4 07:58:25 2024 +0100

    docs: changed code comments to match convention

commit f5f10da
Author: jonathan-mayer <[email protected]>
Date:   Fri Oct 25 09:07:19 2024 +0200

    feat: add how to run the website in readme

commit 7371c33
Merge: e0d03c3 e20981b
Author: jonathan-mayer <[email protected]>
Date:   Fri Oct 25 08:52:15 2024 +0200

    Merge branch 'main' into feat/add-content-to-site

commit e20981b
Author: Jonathan Mayer <[email protected]>
Date:   Thu Oct 24 15:50:12 2024 +0200

    fix: invalid email in pre commit workflow (#66)

* fix: adjust config to better meet needs and be a bit stricter

* chore: automatically push pre-commit changes

* Merge feat/AddHelmDocs

* chore: bump deps

* fix: pre commit violations

* refactor: merge configs

* fix: pre commit workflow not fixing everything sometimes

* chore: automatically push pre-commit changes

* fix: not working on mdx files

* chore: automatically push pre-commit changes

* fix: duplicate helm chart category

* fix: duplicate workflows doc

* fix: duplicate line in readme

* chore: fix typo

Co-authored-by: Jan <[email protected]>

---------

Co-authored-by: Jan <[email protected]>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: Jan <[email protected]>
@JTaeuber JTaeuber added blocked A PR which is blocked by other Issues/PRs and removed blocked A PR which is blocked by other Issues/PRs labels Jan 14, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
blocked A PR which is blocked by other Issues/PRs documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Implement GitBook-like documentation
2 participants