Skip to content

Commit a6a9792

Browse files
vmaertenpd93
andauthored
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 <[email protected]>
1 parent ce032dc commit a6a9792

File tree

2 files changed

+34
-34
lines changed

2 files changed

+34
-34
lines changed

website/docs/experiments/experiments.mdx

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -50,33 +50,33 @@ Which method you use depends on how you intend to use the experiment:
5050
export TASK_X_FEATURE=1
5151
```
5252

53-
3. Creating a `.env` or a `.task-experiments.yml` file in the same directory as
53+
3. Creating a `.env` or a `.taskrc.yml` file in the same directory as
5454
your root Taskfile.\
5555
The `.env` file should contain the relevant environment
56-
variable(s), while the `.task-experiments.yml` file should use a YAML format
56+
variable(s), while the `.taskrc.yml` file should use a YAML format
5757
where each experiment is defined as a key with a corresponding value.
5858

5959
This allows you to enable an experimental feature at a project level. If you
6060
commit this file to source control, then other users of your project will
6161
also have these experiments enabled.
6262

63-
If both files are present, the values in the `.task-experiments.yml` file
63+
If both files are present, the values in the `.taskrc.yml` file
6464
will take precedence.
6565

66-
<Tabs values={[ {label: '.task-experiments.yml', value: 'yaml'}, {label: '.env', value: 'env'}]}>
67-
<TabItem value="yaml">
68-
```yaml title=".taskrc.yml"
69-
experiments:
70-
FEATURE: 1
71-
```
72-
</TabItem>
73-
74-
<TabItem value="env">
75-
```shell title=".env"
76-
TASK_X_FEATURE=1
77-
```
78-
</TabItem>
79-
</Tabs>
66+
<Tabs values={[ {label: '.taskrc.yml', value: 'yaml'}, {label: '.env', value: 'env'}]}>
67+
<TabItem value="yaml">
68+
```yaml title=".taskrc.yml"
69+
experiments:
70+
FEATURE: 1
71+
```
72+
</TabItem>
73+
74+
<TabItem value="env">
75+
```shell title=".env"
76+
TASK_X_FEATURE=1
77+
```
78+
</TabItem>
79+
</Tabs>
8080

8181
## Workflow
8282

website/versioned_docs/version-latest/experiments/experiments.mdx

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -50,33 +50,33 @@ Which method you use depends on how you intend to use the experiment:
5050
export TASK_X_FEATURE=1
5151
```
5252

53-
3. Creating a `.env` or a `.task-experiments.yml` file in the same directory as
53+
3. Creating a `.env` or a `.taskrc.yml` file in the same directory as
5454
your root Taskfile.\
5555
The `.env` file should contain the relevant environment
56-
variable(s), while the `.task-experiments.yml` file should use a YAML format
56+
variable(s), while the `.taskrc.yml` file should use a YAML format
5757
where each experiment is defined as a key with a corresponding value.
5858

5959
This allows you to enable an experimental feature at a project level. If you
6060
commit this file to source control, then other users of your project will
6161
also have these experiments enabled.
6262

63-
If both files are present, the values in the `.task-experiments.yml` file
63+
If both files are present, the values in the `.taskrc.yml` file
6464
will take precedence.
6565

66-
<Tabs values={[ {label: '.task-experiments.yml', value: 'yaml'}, {label: '.env', value: 'env'}]}>
67-
<TabItem value="yaml">
68-
```yaml title=".taskrc.yml"
69-
experiments:
70-
FEATURE: 1
71-
```
72-
</TabItem>
73-
74-
<TabItem value="env">
75-
```shell title=".env"
76-
TASK_X_FEATURE=1
77-
```
78-
</TabItem>
79-
</Tabs>
66+
<Tabs values={[ {label: '.taskrc.yml', value: 'yaml'}, {label: '.env', value: 'env'}]}>
67+
<TabItem value="yaml">
68+
```yaml title=".taskrc.yml"
69+
experiments:
70+
FEATURE: 1
71+
```
72+
</TabItem>
73+
74+
<TabItem value="env">
75+
```shell title=".env"
76+
TASK_X_FEATURE=1
77+
```
78+
</TabItem>
79+
</Tabs>
8080

8181
## Workflow
8282

0 commit comments

Comments
 (0)