[pull] master from OWASP:master

.github/workflows/ci.yml

@@ -0,0 +1,25 @@
+name: ci
+on:
+  push:
+    branches:
+      - master
+permissions:
+  contents: write
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-python@v4
+        with:
+          python-version: 3.x
+      - run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
+      - uses: actions/cache@v3
+        with:
+          key: mkdocs-material-${{ env.cache_id }}
+          path: .cache
+          restore-keys: |
+            mkdocs-material-
+      - run: pip install mkdocs-material==9.0.9
+      - run: pip install git+https://github.com/PauloASilva/mkdocs-monorepo-plugin@feat/i18n
+      - run: mkdocs gh-deploy --force

CONTRIBUTING.md

@@ -1,5 +1,4 @@
-How to Contribute
-=================
+# How to Contribute
 
 When contributing to this repository, please first discuss the change you wish
 to make via submitting an issue with the owners of this repository before making
@@ -9,6 +8,7 @@ discussion.
 ## Branching Model
 
 This repository holds two main branches with an infinite lifetime:
+
 * `master` is the default branch which always reflects the latest release.
 * `develop` is the main branch reflecting the latest delivered changes for the
   next release. When the `develop` branch reaches a stable point and is ready to
@@ -22,38 +22,58 @@ branches have a limited lifespan, since they will be removed eventually.
 Contributions to this repository are welcome. For ease of managing, please
 follow the steps below:
 
-1. Fork this repository to your account.
+1.  Fork this repository to your account.
+
+2.  Clone your copy of this repository, locally.
+
+    ```
+    git clone https://github.com/YOU/API-Security.git
+    ```
+
+3.  Create a new branch based on `develop` (e.g., `fix/foreword-section`).
+
+    ```
+    git checkout develop && git checkout -b fix/foreword-section
+    ```
+
+4.  Apply your changes.
+
+    Please, always follow our style conventions.
+
+
+    Although there's an [`.editorconfig` file][1] on repository's root, your
+    editor may not support it. To learn more about [EditorConfig][2] and text
+    editors/IDEs support, check the website: https://editorconfig.org/.
+    You can preview your changes, [rendering the web site locally][4].
+
+5.  Commit your changes.
+
+    1.  Check modified files and add only required ones (e.g., build artifacts
+        SHOULD NOT be tracked).
+    2.  The first line of the commit message should provide a brief description
+        of your changes. You can go into more details on the optional commit
+        message body.
 
-2. Clone your copy of this repository, locally.
-   ```
-   git clone https://github.com/YOU/API-Security.git
-   ```
-3. Create a new branch based on `develop` (e.g., `fix/foreword-section`).
-   ```
-   git checkout develop && git checkout -b fix/foreword-section
-   ```
-4. Apply your changes.
+6.  Push changes to your public repository.
 
-   Please, always follow our style conventions.
+    ```
+    git push origin fix/foreword-section
+    ```
 
-   Although there's an [`.editorconfig` file][1] on repository's root, your
-   editor may not support it. To learn more about [EditorConfig][2] and text
-   editors/IDEs support, check the website: https://editorconfig.org/.
+7.  Open a Pull Request from your `fix/foreword-section` to the upstream
+    repository `develop` branch.
 
-5. Commit your changes.
+### Rendering the Web Site Locally
 
-   1. Check modified files and add only required ones (e.g., build artifacts
-      SHOULD NOT be tracked).
-   2. The first line of the commit message should provide a brief description of
-      your changes. You can go into more details on the optional commit message
-      body.
+The web site is built using [Material for MkDocs][3] and several plugin.
+Although you can manually install everything, we've bundled everything into a
+Docker image that you can use to render the web site locally:
 
-6. Push changes to your public repository.
-   ```
-   git push origin fix/foreword-section
-   ```
-7. Open a Pull Request from your `fix/foreword-section` to the upstream
-   repository `develop` branch.
+```
+docker compose up
+```
 
-[1]: .editorconfig
+[1]: https://github.com/OWASP/API-Security/blob/master/.editorconfig
 [2]: https://editorconfig.org/
+[3]: https://squidfunk.github.io/mkdocs-material/
+[4]: #rendering-the-web-site-locally

Dockerfile

@@ -0,0 +1,7 @@
+FROM squidfunk/mkdocs-material:9.0.9
+
+ENV MKDOCS_MONOREPO_REPO=https://github.com/PauloASilva/mkdocs-monorepo-plugin
+ENV MKDOCS_MONOREPO_BRANCH="feat/i18n"
+
+RUN python -m pip install git+$MKDOCS_MONOREPO_REPO@$MKDOCS_MONOREPO_BRANCH
+RUN python -m pip install pymdown-extensions