website: fix typos (#20996)

2026-06-17 19:09:11 +03:00 · 2026-03-20 12:43:34 -04:00
parent e3ddc0422a
commit 090d09fcdd
95 changed files with 279 additions and 280 deletions
@@ -5,7 +5,7 @@ title: Writing documentation
 import TabItem from "@theme/TabItem";
 import Tabs from "@theme/Tabs";

-Writing documentation for authentik is a great way for both new and experienced users to improve and contribute to the project. We appreciate contributions to our documentation; everything from fixing a typo to adding additional content to writing a completely new topic.
+Writing documentation for authentik is a great way for both new and experienced users to improve and contribute to the project. We appreciate contributions to our documentation, from fixing typos and adding content to writing completely new topics.

 The [technical documentation](https://docs.goauthentik.io) and our [integration guides](https://integrations.goauthentik.io/) are built, formatted, and tested using `npm`. The commands to build the content locally are defined in the `Makefile` in the root of the repository. Each command is prefixed with `docs-` or `integrations-` and corresponds to an NPM script within the `website` directory.

@@ -22,7 +22,7 @@ authentik documentation is deployed to different subdomains based on the git bra

 ## Guidelines

-Adhering to the following guidelines will help us get your PRs merged much easier and faster, with fewer edits needed.
+Adhering to the following guidelines will help us get your PRs merged more easily and quickly, with fewer edits needed.

 - Ideally, when you are making contributions to the documentation, you should fork and clone our repo, then [build it locally](#set-up-your-local-build-tools), so that you can test the docs and run the required linting and spell checkers before pushing your PR. While you can do much of the writing and editing within the GitHub UI, you cannot run the required linters from the GitHub UI.

@@ -10,9 +10,9 @@ title: Hackathon 2023

 ## Join us for our first authentik hackathon!

-Everyone welcome; we will work on code, docs, and anything else that looks interesting and challenging.
+Everyone is welcome; we will work on code, docs, and anything else that looks interesting and challenging.

-Moderators will be available for most US and European hours, so if during the multi-day event, participants have questions or a PR needs a technical review, we are here for you.
+Moderators will be available for most US and European hours, so if participants have questions during the multi-day event, or if a PR needs a technical review, we are here for you.

 Prizes? Why, Yes! We've got a total prize pool of $5000 and a bunch of cool authentik-branded socks and, indubitably, GitHub fame.

@@ -27,7 +27,7 @@ July 26-30, 2023

 ## Where

-Online, in our [GitHub repo](https://github.com/goauthentik/authentik), and on Discord in our [#hackathon23 channel](https://discord.com/channels/809154715984199690/1110948434552299673) for our Kickoff call, checkins, and the wrap-up and awards events. We will also use the #hackathon23 channel throughout the entire five days, for questions and general chatting. Be sure to first visit our [welcome-info-rules channel](https://discord.com/channels/809154715984199690/813452440660606986), to review our code of conduct and see the latest posts about the hackathon.
+Online, in our [GitHub repo](https://github.com/goauthentik/authentik), and on Discord in our [#hackathon23 channel](https://discord.com/channels/809154715984199690/1110948434552299673) for our Kickoff call, check-ins, and the wrap-up and awards events. We will also use the #hackathon23 channel throughout the entire five days for questions and general chatting. Be sure to first visit our [welcome-info-rules channel](https://discord.com/channels/809154715984199690/813452440660606986) to review our code of conduct and see the latest posts about the hackathon.

 ## Take a look on GitHub

@@ -6,7 +6,7 @@ This page describes how to debug different components of an authentik instance,

 ## authentik Server & Worker (Python)

-The majority of the authentik codebase is in Python, running in Gunicorn for the server and Dramatiq for the worker. These instructions show how this code can be debugged/inspected. The local debugging setup requires a setup as described in [Full development environment](./full-dev-environment.mdx)
+The majority of the authentik codebase is in Python, running in Gunicorn for the server and Dramatiq for the worker. These instructions show how this code can be debugged or inspected. The local debugging setup requires the setup described in [Full development environment](./full-dev-environment.mdx).

 Note that authentik uses [debugpy](https://github.com/microsoft/debugpy), which relies on the "Debug Adapter Protocol" (DAP). These instructions demonstrate debugging using [Visual Studio Code](https://code.visualstudio.com/), however they should be adaptable to other editors that support DAP.

@@ -28,7 +28,7 @@ Whichever process is first started listens on port `9901`. Additional processes

 When debugging an authentik instance running in containers, there are some additional steps that need to be taken in addition to the steps above.

-A local clone of the authentik repository is required to be able to set breakpoints in the code. The locally checked out repository must be on the same version/commit as the authentik version running in the containers. To checkout version 2024.12.3 for example, you can run `git checkout version/2024.12.3`.
+A local clone of the authentik repository is required to set breakpoints in the code. The locally checked out repository must be on the same version/commit as the authentik version running in the containers. To check out version 2024.12.3, for example, run `git checkout version/2024.12.3`.

 The debug port needs to be accessible on the local machine. By default, this is port 9901. Additionally, the container being debugged must be started as `root`, because additional dependencies need to be installed on startup.

@@ -50,7 +50,7 @@ services:

 After re-creating the containers with `AUTHENTIK_DEBUGGER` set to `true` and the port mapped, the steps are identical to the steps above.

-If the authentik instance is running on a remote server, the `.vscode/launch.json` file needs to be adjusted to point to the IP of the remote server. Alternatively, it is also possible to forward the debug port via an SSH tunnel, using `-L 9901:127.0.0.1:9901`.
+If the authentik instance is running on a remote server, the `.vscode/launch.json` file needs to be adjusted to point to the IP of the remote server. Alternatively, you can forward the debug port via an SSH tunnel, using `-L 9901:127.0.0.1:9901`.

 ## authentik Server / Outposts (Golang)

@@ -35,7 +35,7 @@ If you're focusing solely on frontend development, you can create a minimal deve
    echo "AUTHENTIK_TAG=gh-next" >> ./lifecycle/container/.env
    echo "AUTHENTIK_OUTPOSTS__CONTAINER_IMAGE_BASE=ghcr.io/goauthentik/dev-%(type)s:gh-next" >> ./lifecycle/container/.env
    echo "AUTHENTIK_LOG_LEVEL=debug" >> ./lifecycle/container/.env
-    echo "GIT_BUILD_HASH="dev"" >> ./lifecycle/container/.env
+    echo 'GIT_BUILD_HASH="dev"' >> ./lifecycle/container/.env
    ```

 3. Create a Docker Compose override file (`compose.override.yml`) in the root of the repository. This will override the volume configurations for the local configuration file (`local.env.yml`) and mount the directory for the frontend code (`web`) into the docker containers. Docker will automatically mount the web files generated by the build process. The `local.env.yml` mount is optional, but allows you to override the default configuration.
@@ -48,7 +48,7 @@ If you're focusing solely on frontend development, you can create a minimal deve
                - ./local.env.yml:/local.env.yml
    ```

-4. From the repository root, run the front-end build script. This will install the npm packages needed to run the frontend project and start the project in watch mode.
+4. From the repository root, run the frontend build script. This will install the npm packages needed to run the frontend project and start the project in watch mode.

    ```shell
    make node-install
@@ -131,7 +131,7 @@ make migrate
 ```

 :::info
-If you ever want to start over, use `make dev-reset` which drops and restores the authentik PostgreSQL database to the state it was after you ran after `make migrate`.
+If you ever want to start over, use `make dev-reset`, which drops and restores the authentik PostgreSQL database to the state it was in after you ran `make migrate`.
 :::

 ## 5. Running authentik
@@ -159,7 +159,7 @@ To set a password for the default admin user (**akadmin**):
 1. Navigate to http://localhost:9000/if/flow/initial-setup/ in your browser.
 2. Follow the prompts to set up your admin account.

-From now on, you can now access authentik at http://localhost:9000 using the credentials you defined in Step 2.
+From now on, you can access authentik at http://localhost:9000 using the credentials you defined in Step 2.

 ## 6. Build the frontend

@@ -183,7 +183,7 @@ When `AUTHENTIK_DEBUG` is set to `true` (the default for the development environ

 ### Recovery key

-If you can't login anymore or the authentication flow repeats (perhaps due to an incorrectly configured stage or a failed flow import), you can create a recovery key by running this command in your terminal:
+If you can no longer log in or the authentication flow repeats (perhaps due to an incorrectly configured stage or a failed flow import), you can create a recovery key by running this command in your terminal:

 `uv run ak create_recovery_key 10 akadmin`

@@ -2,9 +2,9 @@
 title: Translations
 ---

-Translation in authentik is done in two places. Most of the text is defined in the frontend in `web/`, and a subset of messages is defined in the backend.
+Translations in authentik are handled in two places. Most of the text is defined in the frontend in `web/`, and a subset of messages is defined in the backend.

-The frontend uses [@lit/localize](https://lit.dev/docs/localization/overview/), and the backend uses the built-in django translation tools.
+The frontend uses [@lit/localize](https://lit.dev/docs/localization/overview/), and the backend uses the built-in Django translation tools.

 :::info
 Please review the [Writing documentation](./docs/writing-documentation.md) guidelines as they apply to documentation too.