Feat/add content to site

.github/workflows/pre_commit.yaml

@@ -30,8 +30,8 @@ jobs:
           SKIP: "no-commit-to-branch" # if not skipped, will always fail on main
       - name: Push changes
         run: |
-          git config --global user.name "github-actions"
-          git config --global user.email "github-actions@github.com"
+          git config --global user.name "github-actions[bot]"
+          git config --global user.email "github-actions[bot]@users.noreply.github.com"
           git add .
           if git diff-index --quiet HEAD; then
             echo "No changes were made"

.pre-commit-config.yaml

@@ -1,7 +1,7 @@
 fail_fast: true
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v2.3.0
+    rev: v5.0.0
     hooks:
       - id: end-of-file-fixer
       - id: trailing-whitespace
@@ -22,26 +22,16 @@ repos:
     rev: v3.0.1
     hooks:
       - id: prettier
-        files: \.md$
+        files: \.(md|mdx)$
   - repo: local
     hooks:
       - id: prevent-todo-comments
         name: prevent todo comments
-        entry: '\/\/ *(TODO|FIXME)\b' # matches a golang comment beginning with "TODO" or "FIXME"
+        entry: '( |^)(//|#|<!--|/\*)\s*(TODO|FIXME)\b' # matches a comment beginning with "TODO" or "FIXME"
         language: pygrep
-        files: \.go$
+        files: \.(go|md|mdx|yaml|json|js|ts|jsx|tsx)$
       - id: prevent-too-small-headings
         name: prevent too small headings
-        entry: "^#{5,} " # matches a h5 or smaller markdown heading
+        entry: "^#{5,} " # matches an h5 or smaller markdown heading
         language: pygrep
-        files: \.md$
-      - id: prevent-overly-nested-hierarchy
-        name: prevent overly nested hierarchy
-        entry: "^(  ){2,}- " # matches a markdown list with 2 or more indentations
-        language: pygrep
-        files: \.md$
-      - id: prevent-invalid-alert-types
-        name: prevent invalid alert types
-        entry: '(?i)^> \[!(?!\b(?:NOTE|TIP|IMPORTANT|WARNING|CAUTION)\b).+\]' # matches a github markdown callout/alert that doesn't use one of the supported keywords
-        language: pygrep
-        files: \.md$
+        files: \.(md|mdx)$

CONTRIBUTING.md

@@ -36,27 +36,31 @@ Commits:
 
 Try to stick to golang best practices and standards:
 
-<!-- keep this list updated everytime someone opens a pr with best practice issues  -->
+<!-- keep this list updated every time someone opens a pr with best practice issues  -->
 
-- Package structure standards: https://github.com/golang-standards/project-layout
+- [Package structure standards](https://github.com/golang-standards/project-layout)
 - Use guard clauses if applicable
 - Try to avoid using else. Most of the time these can be replaced by just placing the else block content directly after the if or by refactoring the if block to be an additional function.
 - Comments on funcs/types (esp. public ones)
 - Only make functions public if necessary
 
 ## Issues
 
-If applicable use the issue template. This ensures a consistent structure which makes it easier to find important details.
-Issues which aren't ready for processing, can be marked as a draft by writing "Draft: " infront of the issue name.
+If applicable use the issue template.
+This ensures a consistent structure which makes it easier to find important details.
+Issues which aren't ready for processing, can be marked as a draft by writing "Draft: " in front of the issue name.
 
 ## Pull Requests
 
-Use the Pull Request Template. This ensures a consistent structure which makes it easier to find important details.
+Use the Pull Request Template.
+This ensures a consistent structure which makes it easier to find important details.
 Set yourself and any other collaborators as assignee.
 
 ## Pre Commit
 
-It is recommended to install pre-commit. This insures that formatting is consistent, you don't commit to protected branches and you don't accidentally commit broken code or new functionality without changing the tests. The installation process is in the [README](README.md#setting-up-pre-commit)
+It is recommended to install pre-commit.
+This ensures that formatting is consistent, you don't commit to protected branches and you don't accidentally commit broken code or new functionality without changing the tests.
+The installation process is on [our website](https://caas-team.github.io/GoKubeDownscaler/guides/developing#setting-up-pre-commit).
 
 ## Versioning
 
@@ -67,7 +71,7 @@ Releases are following the semver versioning standard:
 Layout: `<Major>.<Minor>.<Patch>` (example: 1.1.0)
 
 - MAJOR: increment on breaking changes
-- MINOR: increment on new funcitonality/features
+- MINOR: increment on new functionality/features
 - PATCH: increment on small bug fixes
 
-You can find more infomration on semantic versioning here [here](https://semver.org/)
+You can find more information on semantic versioning [on the official website](https://semver.org/).