diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml new file mode 100644 index 0000000..c4f6ee6 --- /dev/null +++ b/.github/workflows/docs.yml @@ -0,0 +1,41 @@ +name: Documentation + +on: + push: + branches: + - master + - develop + pull_request: + branches: + - master + - develop + +jobs: + link-checker: + name: Check links + runs-on: ubuntu-latest + steps: + - name: Checkout the repository + uses: actions/checkout@v4 + + - name: Check the links + uses: lycheeverse/lychee-action@v1 + with: + args: --max-concurrency 1 -v *.md + fail: true + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + + spelling-checker: + name: Check spelling + runs-on: ubuntu-latest + steps: + - name: Checkout the repository + uses: actions/checkout@v4 + + - name: Check spelling mistakes + uses: codespell-project/actions-codespell@master + with: + check_filenames: true + check_hidden: true + path: "*.md" diff --git a/README.md b/README.md index 92a6986..1ab056a 100644 --- a/README.md +++ b/README.md @@ -41,6 +41,8 @@ + + ## What is Alaz? [**Alaz**](https://github.com/getanteon/alaz) is an open-source Anteon eBPF agent that can inspect and collect Kubernetes (K8s) service traffic without the need for code instrumentation, sidecars, or service restarts. This is possible due to its use of eBPF technology.