website: add website development setup, update contribution guidelines on PR titles (#4852)

Signed-off-by: Jens Langhammer <jens@goauthentik.io>

CONTRIBUTING.md

@@ -154,12 +154,19 @@ While the prerequisites above must be satisfied prior to having your pull reques
 
 ## Styleguides
 
+### PR naming
+
+-   Use the format of `<package>: <verb> <description>`
+    -   See [here](#authentik-packages) for `package`
+    -   Example: `providers/saml2: fix parsing of requests`
+
 ### Git Commit Messages
 
 -   Use the format of `<package>: <verb> <description>`
     -   See [here](#authentik-packages) for `package`
     -   Example: `providers/saml2: fix parsing of requests`
 -   Reference issues and pull requests liberally after the first line
+-   Naming of commits within a PR does not need to adhere to the guidelines as we squash merge PRs
 
 ### Python Styleguide
 

website/developer-docs/setup/frontend-dev-environment.md

@@ -6,10 +6,14 @@ If you want to only make changes on the UI, you don't need a backend running fro
 
 ### Prerequisites
 
--   Node (any recent version should work, we use 16.x to build)
+-   Node (any recent version should work, we use 18.x to build)
 -   Make (again, any recent version should work)
 -   Docker and docker-compose
 
+:::info
+Depending on platform, some native dependencies might be required. On macOS, run `brew install node@18`, and for docker `brew install --cask docker`
+:::
+
 ### Instructions
 
 1. Clone the git repo from https://github.com/goauthentik/authentik

website/developer-docs/setup/full-dev-environment.md

@@ -24,7 +24,7 @@ poetry install # Install all required dependencies, including development depend
 ```
 
 :::info
-Depending on platform, some native dependencies might be required. On macOS, run `brew install libxmlsec1 libpq`, and for the CLI tools `brew install postgresql redis`
+Depending on platform, some native dependencies might be required. On macOS, run `brew install libxmlsec1 libpq`, and for the CLI tools `brew install postgresql redis node@18`
 :::
 
 To configure authentik to use the local databases, we need a local config file. This file can be generated by running `make gen-dev-config`.

website/developer-docs/setup/website-dev-environment.md

@@ -0,0 +1,21 @@
+---
+title: Website development environment
+---
+
+If you want to only make changes to the website, you only need node.
+
+### Prerequisites
+
+-   Node (any recent version should work, we use 18.x to build)
+-   Make (again, any recent version should work)
+
+:::info
+Depending on platform, some native dependencies might be required. On macOS, run `brew install node@18`
+:::
+
+### Instructions
+
+1. Clone the git repo from https://github.com/goauthentik/authentik
+2. Run `make website-install` to install the website development dependencies
+3. Run `website-watch` to start a development server to see and preview your changes
+4. Finally when you're about to commit your changes, run `make website` to run the linter and auto-formatter.

website/sidebarsDev.js

@@ -35,10 +35,11 @@ module.exports = {
         },
         {
             type: "category",
-            label: "Development",
+            label: "Setup",
             items: [
                 "setup/full-dev-environment",
-                "setup/frontend-only-dev-environment",
+                "setup/frontend-dev-environment",
+                "setup/website-dev-environment",
             ],
         },
         {