From a6a9792b7e32aaac7946fc067f12cad462764dcb Mon Sep 17 00:00:00 2001 From: Valentin Maerten Date: Thu, 3 Apr 2025 13:29:00 +0200 Subject: [PATCH] docs: use .taskrc instead of .task-experiments.yml in our docs (#2157) * docs: use .taskrc instead of .task-experiments.yml in our docs * fix formatting * fix: whitespace in experiments.mdx --------- Co-authored-by: Pete Davison --- website/docs/experiments/experiments.mdx | 32 +++++++++---------- .../experiments/experiments.mdx | 32 +++++++++---------- 2 files changed, 32 insertions(+), 32 deletions(-) diff --git a/website/docs/experiments/experiments.mdx b/website/docs/experiments/experiments.mdx index a8636cdb..f303a870 100644 --- a/website/docs/experiments/experiments.mdx +++ b/website/docs/experiments/experiments.mdx @@ -50,33 +50,33 @@ Which method you use depends on how you intend to use the experiment: export TASK_X_FEATURE=1 ``` -3. Creating a `.env` or a `.task-experiments.yml` file in the same directory as +3. Creating a `.env` or a `.taskrc.yml` file in the same directory as your root Taskfile.\ The `.env` file should contain the relevant environment - variable(s), while the `.task-experiments.yml` file should use a YAML format + variable(s), while the `.taskrc.yml` file should use a YAML format where each experiment is defined as a key with a corresponding value. This allows you to enable an experimental feature at a project level. If you commit this file to source control, then other users of your project will also have these experiments enabled. - If both files are present, the values in the `.task-experiments.yml` file + If both files are present, the values in the `.taskrc.yml` file will take precedence. - - - ```yaml title=".taskrc.yml" - experiments: - FEATURE: 1 - ``` - + + + ```yaml title=".taskrc.yml" + experiments: + FEATURE: 1 + ``` + - - ```shell title=".env" - TASK_X_FEATURE=1 - ``` - - + + ```shell title=".env" + TASK_X_FEATURE=1 + ``` + + ## Workflow diff --git a/website/versioned_docs/version-latest/experiments/experiments.mdx b/website/versioned_docs/version-latest/experiments/experiments.mdx index a8636cdb..f303a870 100644 --- a/website/versioned_docs/version-latest/experiments/experiments.mdx +++ b/website/versioned_docs/version-latest/experiments/experiments.mdx @@ -50,33 +50,33 @@ Which method you use depends on how you intend to use the experiment: export TASK_X_FEATURE=1 ``` -3. Creating a `.env` or a `.task-experiments.yml` file in the same directory as +3. Creating a `.env` or a `.taskrc.yml` file in the same directory as your root Taskfile.\ The `.env` file should contain the relevant environment - variable(s), while the `.task-experiments.yml` file should use a YAML format + variable(s), while the `.taskrc.yml` file should use a YAML format where each experiment is defined as a key with a corresponding value. This allows you to enable an experimental feature at a project level. If you commit this file to source control, then other users of your project will also have these experiments enabled. - If both files are present, the values in the `.task-experiments.yml` file + If both files are present, the values in the `.taskrc.yml` file will take precedence. - - - ```yaml title=".taskrc.yml" - experiments: - FEATURE: 1 - ``` - + + + ```yaml title=".taskrc.yml" + experiments: + FEATURE: 1 + ``` + - - ```shell title=".env" - TASK_X_FEATURE=1 - ``` - - + + ```shell title=".env" + TASK_X_FEATURE=1 + ``` + + ## Workflow