prerender_false

bencherdev · Dec 3, 2023 · 2cca5a7 · 2cca5a7
1 parent 3cfb3f0
commit 2cca5a7
Show file tree

Hide file tree

Showing 65 changed files with 70 additions and 20 deletions.
diff --git a/services/console/lychee.toml b/services/console/lychee.toml
@@ -1,11 +1,15 @@
-base = "https://bencher.dev"
+# Use this for testing production
+# base = "https://bencher.dev"
 exclude = [
     "http://localhost:3000/",
     "https://discord.gg/yGEsdUh7R4",
     "https://github.com/bencherdev/bencher/issues/new*",
+    # TODO figure out why this page 404s
+    # "https://bencher.dev/docs/[a-z]{2}/reference/api",
 ]
 # TODO remove exclude paths once `--cookie-jar` is stable
 # https://github.com/lycheeverse/lychee/commit/14e748793e8a08d7c2130f63896074f4980204cb
+# Netlify paths
 exclude_path = [
     "./services/console/dist/docs/reference/prior-art/index.html",
     "./services/console/dist/docs/de/reference/prior-art/index.html",

diff --git a/services/console/src/chunks/reference/en/changelog.mdx b/services/console/src/chunks/reference/en/changelog.mdx
@@ -219,7 +219,7 @@
 
 ## `v0.2.30`
 - Added `--if-else-branch`, `--else-branch`, and `--endif-branch` flags to to `bencher run` CLI
-- Wrote a [branch management](/explanation/branch-management) explanation page for using `bencher run`
+- Wrote a [branch management](/explanation/branch-selection) explanation page for using `bencher run`
 - Completely refactored docs UI configuration to make it easier to add new pages, one place instead of three
 - Made the [Diataxis](https://diataxis.fr/) convention explicit in the docs
 - Fixed bounds bug in `bencher mock`

diff --git a/services/console/src/content/how_to/de/github-actions.mdx b/services/console/src/content/how_to/de/github-actions.mdx
@@ -44,7 +44,7 @@ Wenn Sie nur erwarten, dass Sie PRs von Zweigen innerhalb des **gleichen** Repos
         1. Die aktuellen Branch-Daten zu verwenden, wenn sie bereits existieren. (z.B.: `--if-branch "$GITHUB_REF_NAME"`)
         2. Erstellen Sie einen Klon der PR-Zielbranch-Daten und Schwellenwert, wenn sie bereits existieren. (z.B.: `--else-if-branch "$GITHUB_BASE_REF"`)
         3. Ansonsten erstellen Sie einen Klon der `main` Branch-Daten und Schwellenwerte. (z.B.: `--else-if-branch main`)
-        4. Es gibt mehrere Optionen für die Einstellung des Projektbranches. Siehe [Branch Auswahl](/docs/de/how-to/branch-selection) für einen vollständigen Überblick.
+        4. Es gibt mehrere Optionen für die Einstellung des Projektbranches. Siehe [Branch Auswahl](/docs/de/explanation/branch-selection) für einen vollständigen Überblick.
 3. Setzen Sie das GitHub API Authentifizierungstoken. (z.B.: `--github-actions ${{ secrets.GITHUB_TOKEN }}`) Wenn diese Option als Teil einer Pull-Anfrage gesetzt ist, werden die Ergebnisse als Kommentar zur Pull-Anfrage hinzugefügt. Dies verwendet [die GitHub Actions `GITHUB_TOKEN` Umgebungsvariable](https://docs.github.com/de/actions/security-guides/automatic-token-authentication).
 4. Siehe die [bencher run](/docs/de/explanation/bencher-run) Dokumentation für einen vollständigen Überblick über alle Möglichkeiten zur Konfiguration des Pull-Anfragen-Kommentars mit den `--ci-*` Flags.
 

diff --git a/services/console/src/content/how_to/de/gitlab-ci-cd.mdx b/services/console/src/content/how_to/de/gitlab-ci-cd.mdx
@@ -42,7 +42,7 @@ import { BENCHER_VERSION } from "../../../util/ext";
 1. Optional: Erstellen Sie eine Umgebungsvariable, um die übersichtliche Kontrolle der verwendeten CLI-Version zu erleichtern. (z.B.: <code>{`BENCHER_VERSION: ${BENCHER_VERSION}`}</code>)
 1. Laden Sie die Bencher CLI herunter und installieren Sie sie von einer `.deb` Datei.
 1. Verfolgen Sie Ihre Benchmarks mit dem Befehl <code><a href="/docs/de/explanation/bencher-run">bencher run</a></code> CLI-Unterbefehl:
-    1. Es gibt mehrere Optionen zum Einstellen des Projektablaufs. Weitere Einzelheiten finden Sie unter [Zweigauswahl](/docs/de/how-to/branch-selection). Der bereitgestellte Befehl verwendet [GitLab CI/CD vorausdefinierte Variablen](https://docs.gitlab.com/ee/ci/variables/predefined_variables.html) und versucht:
+    1. Es gibt mehrere Optionen zum Einstellen des Projektablaufs. Weitere Einzelheiten finden Sie unter [Zweigauswahl](/docs/de/explanation/branch-selection). Der bereitgestellte Befehl verwendet [GitLab CI/CD vorausdefinierte Variablen](https://docs.gitlab.com/ee/ci/variables/predefined_variables.html) und versucht:
         1. Verwenden Sie den aktuellen Zweig, wenn er bereits existiert. (z.B.: `--if-branch "$CI_COMMIT_REF_NAME"`)
         1. Erstellen Sie einen Klon der MR-Zielbranchdaten und -schwellenwerte, wenn sie bereits existieren. (z.B.: `--else-if-branch "$CI_MERGE_REQUEST_TARGET_BRANCH_NAME"`)
         1. Andernfalls erstellen Sie einen Klon der `main` Branch-Daten und -Schwellenwerte. (z.B.: `--else-if-branch main`)

diff --git a/services/console/src/content/how_to/en/github-actions.mdx b/services/console/src/content/how_to/en/github-actions.mdx
@@ -44,7 +44,7 @@ If you only expect to have PRs from branches within the **same** repository then
         1. Use the current branch data if it already exists. (ex: `--if-branch "$GITHUB_REF_NAME"`)
         2. Create a clone of the PR target branch data and thresholds if it already exists. (ex: `--else-if-branch "$GITHUB_BASE_REF"`)
         3. Otherwise, create a clone of the `main` branch data and thresholds. (ex: `--else-if-branch main`)
-        4. There are several options for setting the project branch. See [branch selection](/docs/how-to/branch-selection) for a full overview.
+        4. There are several options for setting the project branch. See [branch selection](/docs/explanation/branch-selection) for a full overview.
 3. Set the GitHub API authentication token. (ex: `--github-actions ${{ secrets.GITHUB_TOKEN }}`) When this option is set as a part of a pull request, then the results will be added to the pull request as a comment. This uses [the GitHub Actions `GITHUB_TOKEN` environment variable](https://docs.github.com/en/actions/security-guides/automatic-token-authentication).
 4. See the [bencher run](/docs/explanation/bencher-run) documentation for a full overview of all the ways to configure the pull request comment with the `--ci-*` flags.
 

diff --git a/services/console/src/content/how_to/en/gitlab-ci-cd.mdx b/services/console/src/content/how_to/en/gitlab-ci-cd.mdx
@@ -42,7 +42,7 @@ import { BENCHER_VERSION } from "../../../util/ext";
 1. Optional: Create an environment variable to make it easy to keep track the CLI version being used. (ex: <code>{`BENCHER_VERSION: ${BENCHER_VERSION}`}</code>)
 1. Download and install the Bencher CLI from a `.deb`.
 1. [Track your benchmarks](/docs/how-to/track-benchmarks) with the <code><a href="/docs/explanation/bencher-run">bencher run</a></code> CLI subcommand:
-    1. There are several options for setting the project branch. See [branch selection](/docs/how-to/branch-selection) for a full overview. The provided command uses [GitLab CI/CD predefined variables](https://docs.gitlab.com/ee/ci/variables/predefined_variables.html) and it tries to:
+    1. There are several options for setting the project branch. See [branch selection](/docs/explanation/branch-selection) for a full overview. The provided command uses [GitLab CI/CD predefined variables](https://docs.gitlab.com/ee/ci/variables/predefined_variables.html) and it tries to:
         1. Use the current branch if it already exists. (ex: `--if-branch "$CI_COMMIT_REF_NAME"`)
         1. Create a clone of MR target branch data and thresholds if it already exists. (ex: `--else-if-branch  "$CI_MERGE_REQUEST_TARGET_BRANCH_NAME"`)
         1. Otherwise, create a clone of the `main` branch data and thresholds. (ex: `--else-if-branch main`)

diff --git a/services/console/src/content/how_to/es/github-actions.mdx b/services/console/src/content/how_to/es/github-actions.mdx
@@ -44,7 +44,7 @@ Si solo esperas tener PRs desde las branch dentro del **mismo** repositorio ento
         1. Usa los datos de la branch actual si ya existen. (p.ej: `--if-branch "$GITHUB_REF_NAME"`)
         2. Crea un clon de los datos y umbrales de la branch objetivo de PR si ya existen. (p.ej: `--else-if-branch "$GITHUB_BASE_REF"`)
         3. De lo contrario, crea un clon de los datos y umbrales de la branch `main`. (p.ej: `--else-if-branch main`)
-        4. Hay varias opciones para ajustar la branch del proyecto. Consulta [selección de branch](/docs/es/how-to/branch-selection) para una visión general completa.
+        4. Hay varias opciones para ajustar la branch del proyecto. Consulta [selección de branch](/docs/es/explanation/branch-selection) para una visión general completa.
 3. Ajusta el token de autenticación de GitHub API. (p.ej: `--github-actions ${{ secrets.GITHUB_TOKEN }}`) Cuando esta opción se ajusta como parte de un pull request, entonces los resultados serán adicionados al pull request como un comentario. Esto usa [la variable de entorno `GITHUB_TOKEN` de GitHub Actions](https://docs.github.com/es/actions/security-guides/automatic-token-authentication).
 4. Consulta la [documentación de bencher run](/docs/es/explanation/bencher-run) para una visión general completa de todas las maneras de configurar el comentario de pull request con las opciones `--ci-*`.
 

diff --git a/services/console/src/content/how_to/es/gitlab-ci-cd.mdx b/services/console/src/content/how_to/es/gitlab-ci-cd.mdx
@@ -42,7 +42,7 @@ import { BENCHER_VERSION } from "../../../util/ext";
 1. Opcional: Crea una variable de entorno para facilitar el seguimiento de la versión de CLI que se está utilizando. (ej: <code>{`BENCHER_VERSION: ${BENCHER_VERSION}`}</code>)
 1. Descarga e instala el CLI de Bencher desde un `.deb`.
 1. [Rastrea tus benchmarks](/docs/es/how-to/track-benchmarks) con el subcomando CLI <code><a href="/docs/es/explanation/bencher-run">bencher run</a></code>:
-    1. Hay varias opciones para establecer la rama del proyecto. Consulta [selección de rama](/docs/es/how-to/branch-selection) para una descripción completa. El comando proporcionado utiliza [variables predefinidas de GitLab CI/CD](https://docs.gitlab.com/ee/ci/variables/predefined_variables.html) e intenta:
+    1. Hay varias opciones para establecer la rama del proyecto. Consulta [selección de rama](/docs/es/explanation/branch-selection) para una descripción completa. El comando proporcionado utiliza [variables predefinidas de GitLab CI/CD](https://docs.gitlab.com/ee/ci/variables/predefined_variables.html) e intenta:
         1. Utilizar la rama actual si ya existe. (ej: `--if-branch "$CI_COMMIT_REF_NAME"`)
         1. Crear un clon de los datos de la rama objetivo MR y los umbrales si ya existe. (ej: `--else-if-branch  "$CI_MERGE_REQUEST_TARGET_BRANCH_NAME"`)
         1. En otro caso, crear un clon de los datos de la rama `main` y los umbrales. (ej: `--else-if-branch main`)

diff --git a/services/console/src/content/how_to/fr/github-actions.mdx b/services/console/src/content/how_to/fr/github-actions.mdx
@@ -44,7 +44,7 @@ Si vous prévoyez uniquement d'avoir des PRs provenant de branches au sein du **
         1. Utiliser des données de branche actuelles si elles existent déjà. (ex: `--if-branch "$GITHUB_REF_NAME"`)
         2. Créer un clone des données et des seuils de la branche cible de la PR si cela existe déjà. (ex: `--else-if-branch "$GITHUB_BASE_REF"`)
         3. Sinon, créez un clone des données et des seuils de la branche `main`. (ex: `--else-if-branch main`)
-        4. Il existe plusieurs options pour définir la branche du projet. Voir la [sélection de branche](/docs/fr/how-to/branch-selection) pour une vue d'ensemble complète.
+        4. Il existe plusieurs options pour définir la branche du projet. Voir la [sélection de branche](/docs/fr/explanation/branch-selection) pour une vue d'ensemble complète.
 3. Paramétrez le jeton d'authentification de l'API GitHub. (ex: `--github-actions ${{ secrets.GITHUB_TOKEN }}`). Lorsque cette option est définie dans le cadre d'une pull request, alors les résultats seront ajoutés à la pull request sous forme de commentaire. Ceci utilise [la variable d'environnement `GITHUB_TOKEN` des GitHub Actions](https://docs.github.com/fr/actions/security-guides/automatic-token-authentication).
 4. Consultez la documentation [bencher run](/docs/fr/explanation/bencher-run) pour une vue d'ensemble complète de toutes les façons de configurer le commentaire de pull request avec les drapeaux `--ci-*`.
 

diff --git a/services/console/src/content/how_to/fr/gitlab-ci-cd.mdx b/services/console/src/content/how_to/fr/gitlab-ci-cd.mdx
@@ -42,7 +42,7 @@ import { BENCHER_VERSION } from "../../../util/ext";
 1. Optionnel : Créez une variable d'environnement pour faciliter le suivi de la version de la CLI utilisée. (ex: <code>{`BENCHER_VERSION: ${BENCHER_VERSION}`}</code>)
 1. Téléchargez et installez la CLI Bencher à partir d'un `.deb`.
 1. [Suivez vos benchmarks](/docs/fr/how-to/track-benchmarks) avec la sous-commande CLI <code><a href="/docs/fr/explanation/bencher-run">bencher run</a></code> :
-    1. Il existe plusieurs options pour définir la branche du projet. Consultez [la sélection de branches](/docs/fr/how-to/branch-selection) pour un aperçu complet. La commande fournie utilise [les variables prédéfinies de GitLab CI/CD](https://docs.gitlab.com/ee/ci/variables/predefined_variables.html) et elle essaie de :
+    1. Il existe plusieurs options pour définir la branche du projet. Consultez [la sélection de branches](/docs/fr/explanation/branch-selection) pour un aperçu complet. La commande fournie utilise [les variables prédéfinies de GitLab CI/CD](https://docs.gitlab.com/ee/ci/variables/predefined_variables.html) et elle essaie de :
         1. Utiliser la branche actuelle si elle existe déjà. (ex: `--if-branch "$CI_COMMIT_REF_NAME"`)
         1. Créer un clône des données et des seuils de la branche cible de MR si elle existe déjà. (ex: `--else-if-branch  "$CI_MERGE_REQUEST_TARGET_BRANCH_NAME"`)
         1. Sinon, créer un clône des données et des seuils de la branche `main`. (ex: `--else-if-branch main`)

diff --git a/services/console/src/content/how_to/ja/github-actions.mdx b/services/console/src/content/how_to/ja/github-actions.mdx
@@ -44,7 +44,7 @@ import GitHubActions6 from "../../../chunks/how_to/github-actions.6.mdx";
         1. すでに存在する場合は、現在のbranchのデータを使用します。(例: `--if-branch "$GITHUB_REF_NAME"`)
         2. すでに存在する場合は、PRターゲットbranchのデータとしきい値をクローンします。(例: `--else-if-branch "$GITHUB_BASE_REF"`)
         3. それ以外の場合は、`main` branchのデータとしきい値をクローンします。(例: `--else-if-branch main`)
-        4. プロジェクトbranchを設定するためのいくつかのオプションがあります。全体の概要については、[branch selection](/docs/ja/how-to/branch-selection) をご覧ください。
+        4. プロジェクトbranchを設定するためのいくつかのオプションがあります。全体の概要については、[branch selection](/docs/ja/explanation/branch-selection) をご覧ください。
 3. GitHub APIの認証トークンを設定します。(例: `--github-actions ${{ secrets.GITHUB_TOKEN }}`) このオプションがプルリクエストの一部として設定されると、結果はプルリクエストにコメントとして追加されます。これは[GitHub Actionsの `GITHUB_TOKEN` 環境変数](https://docs.github.com/ja/actions/security-guides/automatic-token-authentication)を使用します。
 4. `--ci-*` フラグを使用したプルリクエストコメントの設定方法については、[bencher run](/docs/ja/explanation/bencher-run) のドキュメンテーションを全面的にご覧ください。
 

diff --git a/services/console/src/content/how_to/ja/gitlab-ci-cd.mdx b/services/console/src/content/how_to/ja/gitlab-ci-cd.mdx
@@ -42,7 +42,7 @@ import { BENCHER_VERSION } from "../../../util/ext";
 1. オプション：使用中のCLIバージョンを追跡しやすくするための環境変数を作成します。（例：<code>{`BENCHER_VERSION: ${BENCHER_VERSION}`}</code>）
 1. `.deb`からBencher CLIをダウンロードし、インストールします。
 1. <code><a href="/docs/ja/explanation/bencher-run">bencher run</a></code> CLIサブコマンドを使って、あなたのベンチマークを[追跡します](/docs/ja/how-to/track-benchmarks):
-    1. プロジェクトブランチの設定に関してはいくつかの選択肢があります。完全な概観については、[branch selection](/docs/ja/how-to/branch-selection)を参照してください。提供されたコマンドは[GitLab CI/CD predefined variables](https://docs.gitlab.com/ee/ci/variables/predefined_variables.html)を使用し、
+    1. プロジェクトブランチの設定に関してはいくつかの選択肢があります。完全な概観については、[branch selection](/docs/ja/explanation/branch-selection)を参照してください。提供されたコマンドは[GitLab CI/CD predefined variables](https://docs.gitlab.com/ee/ci/variables/predefined_variables.html)を使用し、
         1. すでに存在している場合、現在のブランチを使用します。（例： `--if-branch "$CI_COMMIT_REF_NAME"`）
         1. すでに存在している場合、MRターゲットブランチのデータと閾値のクローンを作成します。（例： `--else-if-branch  "$CI_MERGE_REQUEST_TARGET_BRANCH_NAME"`）
         1. それ以外の場合は、 `main` ブランチのデータと閾値のクローンを作成します。（例： `--else-if-branch main`）

diff --git a/services/console/src/content/how_to/ko/github-actions.mdx b/services/console/src/content/how_to/ko/github-actions.mdx
@@ -44,7 +44,7 @@ Pull Request에서 성능 회귀를 잡아내기 위해 PR에서 벤치마크를
         1. 현재 브랜치 데이터가 이미 존재하면 이를 사용합니다. (예: `--if-branch "$GITHUB_REF_NAME"`)
         2. PR 대상 브랜치 데이터와 임계값이 이미 존재하면 이를 복제해서 만듭니다. (예: `--else-if-branch "$GITHUB_BASE_REF"`)
         3. 그 외의 경우, `main` 브랜치 데이터와 임계값을 복제해서 만듭니다. (예: `--else-if-branch main`)
-        4. 프로젝트 브랜치를 설정하는 데는 여러 가지 옵션이 있습니다. 전체 개요는 [브랜치 선택](/docs/ko/how-to/branch-selection)을 참조하세요.
+        4. 프로젝트 브랜치를 설정하는 데는 여러 가지 옵션이 있습니다. 전체 개요는 [브랜치 선택](/docs/ko/explanation/branch-selection)을 참조하세요.
 3. GitHub API 인증 토큰을 설정합니다. (예: `--github-actions ${{ secrets.GITHUB_TOKEN }}`) 이 옵션이 pull request의 일부로 설정되면, 결과가 pull request에 댓글로 추가됩니다. 이는 [GitHub Actions `GITHUB_TOKEN` 환경 변수](https://docs.github.com/ko/actions/security-guides/automatic-token-authentication)를 사용합니다.
 4. `--ci-*` 플래그로 pull request 댓글을 설정하는 모든 방법에 대한 전체 개요는 [bencher run](/docs/ko/explanation/bencher-run) 문서를 참조하세요.
 

diff --git a/services/console/src/content/how_to/ko/gitlab-ci-cd.mdx b/services/console/src/content/how_to/ko/gitlab-ci-cd.mdx
@@ -42,7 +42,7 @@ import { BENCHER_VERSION } from "../../../util/ext";
 1. 선택 사항: 사용 중인 CLI 버전을 쉽게 추적할 수 있도록 환경 변수를 생성합니다 (예: <code>{`BENCHER_VERSION: ${BENCHER_VERSION}`}</code>)
 1. `.deb`에서 Bencher CLI 를 다운로드하고 설치합니다.
 1. <code><a href="/docs/ko/explanation/bencher-run">bencher run</a></code> CLI 하위 명령어를 이용하여 벤치마크를 추적합니다([벤치마크 추적](/docs/ko/how-to/track-benchmarks) 참조):
-    1. 프로젝트의 브랜치를 설정하는 여러 옵션이 있습니다. 전체 개요는 [브랜치 선택](/docs/ko/how-to/branch-selection)을 참조하십시오. 제공된 명령어는 [GitLab CI/CD 사전 정의 변수](https://docs.gitlab.com/ee/ci/variables/predefined_variables.html)를 사용하며:
+    1. 프로젝트의 브랜치를 설정하는 여러 옵션이 있습니다. 전체 개요는 [브랜치 선택](/docs/ko/explanation/branch-selection)을 참조하십시오. 제공된 명령어는 [GitLab CI/CD 사전 정의 변수](https://docs.gitlab.com/ee/ci/variables/predefined_variables.html)를 사용하며:
         1. 해당 브랜치가 이미 존재하면 해당 브랜치를 사용합니다 (예: `--if-branch "$CI_COMMIT_REF_NAME"`)
         1. MR 타겟 브랜치 데이터와 임계값의 복제본을 생성합니다 (예: `--else-if-branch  "$CI_MERGE_REQUEST_TARGET_BRANCH_NAME"`)
         1. 그렇지 않으면, `main` 브랜치 데이터와 임계값의 복제본을 생성합니다 (예: `--else-if-branch main`)