Skip to content

Commit

Permalink
docs(docusaurus): fix links
Browse files Browse the repository at this point in the history 
It turns out, we have (mostly) been using URL paths instead of file paths, which has downsides. Using relative file paths (with .md extensions) instead of relative URL links provides the following benefits:
- Links will keep working on the GitHub interface and many Markdown editors
- You can customize the files' slugs without having to update all the links
- Moving files around the folders can be tracked by your editor, and some editors may automatically update file links
- A versioned doc will link to another doc of the exact same version
- Relative URL links are very likely to break if you update the trailingSlash config

Reference:
- [File paths and URL paths](https://docusaurus.io/docs/advanced/routing#file-paths-and-url-paths)
- [Markdown links](https://docusaurus.io/docs/markdown-features/links)
  • Loading branch information
@3v0k4
3v0k4 committed Mar 21, 2023
1 parent 826997c commit cfa351e
Show file tree
Hide file tree
Showing 23 changed files with 164 additions and 164 deletions.
54 changes: 27 additions & 27 deletions docusaurus/docs/cypress/guide/index.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -75,9 +75,9 @@ Generate [API tokens](https://knapsackpro.com/dashboard?utm_source=docs_knapsack

For each parallel job, define:

- [`KNAPSACK_PRO_TEST_SUITE_TOKEN_CYPRESS`](/cypress/reference/#knapsack_pro_test_suite_token_cypress)
- [`KNAPSACK_PRO_CI_NODE_TOTAL`](/cypress/reference/#knapsack_pro_ci_node_total)
- [`KNAPSACK_PRO_CI_NODE_INDEX`](/cypress/reference/#knapsack_pro_ci_node_index)
- [`KNAPSACK_PRO_TEST_SUITE_TOKEN_CYPRESS`](../reference.md#knapsack_pro_test_suite_token_cypress)
- [`KNAPSACK_PRO_CI_NODE_TOTAL`](../reference.md#knapsack_pro_ci_node_total)
- [`KNAPSACK_PRO_CI_NODE_INDEX`](../reference.md#knapsack_pro_ci_node_index)

Remember to configure the number of parallel CI nodes in AppVeyor.

Expand Down Expand Up @@ -250,10 +250,10 @@ Generate [API tokens](https://knapsackpro.com/dashboard?utm_source=docs_knapsack

For each [parallel pipeline](https://documentation.codeship.com/basic/builds-and-configuration/parallel-tests/#using-parallel-test-pipelines), define:

- [`KNAPSACK_PRO_TEST_SUITE_TOKEN_CYPRESS`](/cypress/reference/#knapsack_pro_test_suite_token_cypress)
- [`KNAPSACK_PRO_CI_NODE_TOTAL`](/cypress/reference/#knapsack_pro_ci_node_total)
- [`KNAPSACK_PRO_CI_NODE_INDEX`](/cypress/reference/#knapsack_pro_ci_node_index)
- [`KNAPSACK_PRO_FIXED_QUEUE_SPLIT=true`](/cypress/reference/#knapsack_pro_fixed_queue_split)
- [`KNAPSACK_PRO_TEST_SUITE_TOKEN_CYPRESS`](../reference.md#knapsack_pro_test_suite_token_cypress)
- [`KNAPSACK_PRO_CI_NODE_TOTAL`](../reference.md#knapsack_pro_ci_node_total)
- [`KNAPSACK_PRO_CI_NODE_INDEX`](../reference.md#knapsack_pro_ci_node_index)
- [`KNAPSACK_PRO_FIXED_QUEUE_SPLIT=true`](../reference.md#knapsack_pro_fixed_queue_split)

<Tabs>
<TabItem value="node-1" label="Node 1">
Expand Down Expand Up @@ -303,9 +303,9 @@ Generate [API tokens](https://knapsackpro.com/dashboard?utm_source=docs_knapsack

Define in `.codefresh/codefresh.yml`:

- [`KNAPSACK_PRO_TEST_SUITE_TOKEN_CYPRESS`](/cypress/reference/#knapsack_pro_test_suite_token_cypress)
- [`KNAPSACK_PRO_CI_NODE_TOTAL`](/cypress/reference/#knapsack_pro_ci_node_total)
- [`KNAPSACK_PRO_CI_NODE_INDEX`](/cypress/reference/#knapsack_pro_ci_node_index)
- [`KNAPSACK_PRO_TEST_SUITE_TOKEN_CYPRESS`](../reference.md#knapsack_pro_test_suite_token_cypress)
- [`KNAPSACK_PRO_CI_NODE_TOTAL`](../reference.md#knapsack_pro_ci_node_total)
- [`KNAPSACK_PRO_CI_NODE_INDEX`](../reference.md#knapsack_pro_ci_node_index)
- In the `matrix` section, list all the `KNAPSACK_PRO_CI_NODE_INDEX`es (from `0` to `KNAPSACK_PRO_CI_NODE_TOTAL-1`).

Remember to configure the YAML file path on Codefresh: _Pipelines > Settings (cog icon next to the pipeline) > Workflow Tab (horizontal menu on the top) > Path to YAML > `./.codefresh/codefresh.yml`_.
Expand Down Expand Up @@ -401,10 +401,10 @@ Generate [API tokens](https://knapsackpro.com/dashboard?utm_source=docs_knapsack

Define in `.github/workflows/main.yaml`:

- [`KNAPSACK_PRO_TEST_SUITE_TOKEN_CYPRESS`](/cypress/reference/#knapsack_pro_test_suite_token_cypress) in _GitHub Settings > Secrets_ as described in [GitHub Actions' docs](https://docs.github.com/en/actions/security-guides/encrypted-secrets#creating-encrypted-secrets-for-a-repository).
- [`KNAPSACK_PRO_CI_NODE_TOTAL`](/cypress/reference/#knapsack_pro_ci_node_total) using the [`matrix` property](https://help.github.com/en/articles/workflow-syntax-for-github-actions#jobsjob_idstrategymatrix)
- [`KNAPSACK_PRO_CI_NODE_INDEX`](/cypress/reference/#knapsack_pro_ci_node_index) using the [`matrix` property](https://help.github.com/en/articles/workflow-syntax-for-github-actions#jobsjob_idstrategymatrix)
- [`KNAPSACK_PRO_FIXED_QUEUE_SPLIT=true`](/cypress/reference/#knapsack_pro_fixed_queue_split)
- [`KNAPSACK_PRO_TEST_SUITE_TOKEN_CYPRESS`](../reference.md#knapsack_pro_test_suite_token_cypress) in _GitHub Settings > Secrets_ as described in [GitHub Actions' docs](https://docs.github.com/en/actions/security-guides/encrypted-secrets#creating-encrypted-secrets-for-a-repository).
- [`KNAPSACK_PRO_CI_NODE_TOTAL`](../reference.md#knapsack_pro_ci_node_total) using the [`matrix` property](https://help.github.com/en/articles/workflow-syntax-for-github-actions#jobsjob_idstrategymatrix)
- [`KNAPSACK_PRO_CI_NODE_INDEX`](../reference.md#knapsack_pro_ci_node_index) using the [`matrix` property](https://help.github.com/en/articles/workflow-syntax-for-github-actions#jobsjob_idstrategymatrix)
- [`KNAPSACK_PRO_FIXED_QUEUE_SPLIT=true`](../reference.md#knapsack_pro_fixed_queue_split)

Here's an example config:

Expand Down Expand Up @@ -479,9 +479,9 @@ See also [how to configure running parallel CI nodes in GitLab](https://docs.git
Define in `.gitlab-ci.yml`:

- [`KNAPSACK_PRO_TEST_SUITE_TOKEN_CYPRESS`](/cypress/reference/#knapsack_pro_test_suite_token_cypress)
- [`KNAPSACK_PRO_CI_NODE_TOTAL`](/cypress/reference/#knapsack_pro_ci_node_total)
- [`KNAPSACK_PRO_CI_NODE_INDEX`](/cypress/reference/#knapsack_pro_ci_node_index)
- [`KNAPSACK_PRO_TEST_SUITE_TOKEN_CYPRESS`](../reference.md#knapsack_pro_test_suite_token_cypress)
- [`KNAPSACK_PRO_CI_NODE_TOTAL`](../reference.md#knapsack_pro_ci_node_total)
- [`KNAPSACK_PRO_CI_NODE_INDEX`](../reference.md#knapsack_pro_ci_node_index)

Here's an example configuration for 2 parallel jobs:

Expand Down Expand Up @@ -523,7 +523,7 @@ Generate [API tokens](https://knapsackpro.com/dashboard?utm_source=docs_knapsack

Define in `app.json`:

- [`KNAPSACK_PRO_TEST_SUITE_TOKEN_CYPRESS`](/cypress/reference/#knapsack_pro_test_suite_token_cypress)
- [`KNAPSACK_PRO_TEST_SUITE_TOKEN_CYPRESS`](../reference.md#knapsack_pro_test_suite_token_cypress)
- `quantity`: number of parallel dynos
- `test`: the Knapsack Pro command

Expand Down Expand Up @@ -625,7 +625,7 @@ Generate [API tokens](https://knapsackpro.com/dashboard?utm_source=docs_knapsack

Define in `.semaphore/semaphore.yml`:

- [`KNAPSACK_PRO_TEST_SUITE_TOKEN_CYPRESS`](/cypress/reference/#knapsack_pro_test_suite_token_cypress)
- [`KNAPSACK_PRO_TEST_SUITE_TOKEN_CYPRESS`](../reference.md#knapsack_pro_test_suite_token_cypress)
- `parallelism`

Here's an example config:
Expand Down Expand Up @@ -675,10 +675,10 @@ Generate [API tokens](https://knapsackpro.com/dashboard?utm_source=docs_knapsack

Define in `.travis.yml`:

- [`KNAPSACK_PRO_TEST_SUITE_TOKEN_CYPRESS`](/cypress/reference/#knapsack_pro_test_suite_token_cypress)
- [`KNAPSACK_PRO_CI_NODE_TOTAL`](/cypress/reference/#knapsack_pro_ci_node_total)
- [`KNAPSACK_PRO_CI_NODE_INDEX`](/cypress/reference/#knapsack_pro_ci_node_index) as [jobs](http://docs.travis-ci.com/user/speeding-up-the-build/#parallelizing-your-builds-across-virtual-machines)
- [`KNAPSACK_PRO_FIXED_QUEUE_SPLIT=true`](/cypress/reference/#knapsack_pro_fixed_queue_split)
- [`KNAPSACK_PRO_TEST_SUITE_TOKEN_CYPRESS`](../reference.md#knapsack_pro_test_suite_token_cypress)
- [`KNAPSACK_PRO_CI_NODE_TOTAL`](../reference.md#knapsack_pro_ci_node_total)
- [`KNAPSACK_PRO_CI_NODE_INDEX`](../reference.md#knapsack_pro_ci_node_index) as [jobs](http://docs.travis-ci.com/user/speeding-up-the-build/#parallelizing-your-builds-across-virtual-machines)
- [`KNAPSACK_PRO_FIXED_QUEUE_SPLIT=true`](../reference.md#knapsack_pro_fixed_queue_split)

```yaml
script:
Expand Down Expand Up @@ -709,10 +709,10 @@ Generate [API tokens](https://knapsackpro.com/dashboard?utm_source=docs_knapsack

Define the following global environment variables on your CI server:

- [`KNAPSACK_PRO_TEST_SUITE_TOKEN_CYPRESS`](/cypress/reference/#knapsack_pro_test_suite_token_cypress)
- [`KNAPSACK_PRO_CI_NODE_TOTAL`](/cypress/reference/#knapsack_pro_ci_node_total)
- [`KNAPSACK_PRO_CI_NODE_INDEX`](/cypress/reference/#knapsack_pro_ci_node_index)
- [`KNAPSACK_PRO_CI_NODE_BUILD_ID`](/cypress/reference/#knapsack_pro_ci_node_build_id)
- [`KNAPSACK_PRO_TEST_SUITE_TOKEN_CYPRESS`](../reference.md#knapsack_pro_test_suite_token_cypress)
- [`KNAPSACK_PRO_CI_NODE_TOTAL`](../reference.md#knapsack_pro_ci_node_total)
- [`KNAPSACK_PRO_CI_NODE_INDEX`](../reference.md#knapsack_pro_ci_node_index)
- [`KNAPSACK_PRO_CI_NODE_BUILD_ID`](../reference.md#knapsack_pro_ci_node_build_id)

<Tabs>
<TabItem value="node-1" label="Node 1">
Expand Down
2 changes: 1 addition & 1 deletion docusaurus/docs/cypress/reference.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ You can pass all the [supported Cypress CLI options](https://docs.cypress.io/gui
$(npm bin)/knapsack-pro-cypress --browser chrome
```

You can also pass options to Node with environment variables (e.g., [`--max_old_space_size`](/cypress/troubleshooting/#javascript-heap-out-of-memory)).
You can also pass options to Node with environment variables (e.g., [`--max_old_space_size`](troubleshooting.md#javascript-heap-out-of-memory)).

## `KNAPSACK_PRO_BRANCH`

Expand Down
4 changes: 2 additions & 2 deletions docusaurus/docs/cypress/troubleshooting.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ pagination_prev: null

## Error with `--project`

Please use [`KNAPSACK_PRO_TEST_FILE_PATTERN`](/cypress/reference/#knapsack_pro_test_file_pattern) instead of `--project`.
Please use [`KNAPSACK_PRO_TEST_FILE_PATTERN`](reference.md#knapsack_pro_test_file_pattern) instead of `--project`.

If you really need to use `--project`, you can do so with an NPM script:

Expand Down Expand Up @@ -58,4 +58,4 @@ $(npm bin)/knapsack-pro-cypress

## No tests are executed (or `test_files: [ 'parameter is required' ]`)

Make sure [`KNAPSACK_PRO_TEST_FILE_PATTERN`](/cypress/reference/#knapsack_pro_test_file_pattern) is correct.
Make sure [`KNAPSACK_PRO_TEST_FILE_PATTERN`](reference.md#knapsack_pro_test_file_pattern) is correct.
4 changes: 2 additions & 2 deletions docusaurus/docs/jest/cookbook.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -31,10 +31,10 @@ $(npm bin)/knapsack-pro-jest --runInBand
## Use a Jest config file

:::caution
To filter tests use [`KNAPSACK_PRO_TEST_FILE_PATTERN`](/jest/reference/#knapsack_pro_test_file_pattern).
To filter tests use [`KNAPSACK_PRO_TEST_FILE_PATTERN`](reference.md#knapsack_pro_test_file_pattern).
:::

You can pass it with a [command-line argument](/jest/reference/#command-line-arguments):
You can pass it with a [command-line argument](reference.md#command-line-arguments):

```bash
$(npm bin)/knapsack-pro-jest --config=jest.config.e2e.js
Expand Down
54 changes: 27 additions & 27 deletions docusaurus/docs/jest/guide/index.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -66,9 +66,9 @@ Generate [API tokens](https://knapsackpro.com/dashboard?utm_source=docs_knapsack

For each parallel job, define:

- [`KNAPSACK_PRO_TEST_SUITE_TOKEN_JEST`](/jest/reference/#knapsack_pro_test_suite_token_jest)
- [`KNAPSACK_PRO_CI_NODE_TOTAL`](/jest/reference/#knapsack_pro_ci_node_total)
- [`KNAPSACK_PRO_CI_NODE_INDEX`](/jest/reference/#knapsack_pro_ci_node_index)
- [`KNAPSACK_PRO_TEST_SUITE_TOKEN_JEST`](../reference.md#knapsack_pro_test_suite_token_jest)
- [`KNAPSACK_PRO_CI_NODE_TOTAL`](../reference.md#knapsack_pro_ci_node_total)
- [`KNAPSACK_PRO_CI_NODE_INDEX`](../reference.md#knapsack_pro_ci_node_index)

Remember to configure the number of parallel CI nodes in AppVeyor.

Expand Down Expand Up @@ -235,10 +235,10 @@ Generate [API tokens](https://knapsackpro.com/dashboard?utm_source=docs_knapsack

For each [parallel pipeline](https://documentation.codeship.com/basic/builds-and-configuration/parallel-tests/#using-parallel-test-pipelines), define:

- [`KNAPSACK_PRO_TEST_SUITE_TOKEN_JEST`](/jest/reference/#knapsack_pro_test_suite_token_jest)
- [`KNAPSACK_PRO_CI_NODE_TOTAL`](/jest/reference/#knapsack_pro_ci_node_total)
- [`KNAPSACK_PRO_CI_NODE_INDEX`](/jest/reference/#knapsack_pro_ci_node_index)
- [`KNAPSACK_PRO_FIXED_QUEUE_SPLIT=true`](/jest/reference/#knapsack_pro_fixed_queue_split)
- [`KNAPSACK_PRO_TEST_SUITE_TOKEN_JEST`](../reference.md#knapsack_pro_test_suite_token_jest)
- [`KNAPSACK_PRO_CI_NODE_TOTAL`](../reference.md#knapsack_pro_ci_node_total)
- [`KNAPSACK_PRO_CI_NODE_INDEX`](../reference.md#knapsack_pro_ci_node_index)
- [`KNAPSACK_PRO_FIXED_QUEUE_SPLIT=true`](../reference.md#knapsack_pro_fixed_queue_split)

<Tabs>
<TabItem value="node-1" label="Node 1">
Expand Down Expand Up @@ -288,9 +288,9 @@ Generate [API tokens](https://knapsackpro.com/dashboard?utm_source=docs_knapsack

Define in `.codefresh/codefresh.yml`:

- [`KNAPSACK_PRO_TEST_SUITE_TOKEN_JEST`](/jest/reference/#knapsack_pro_test_suite_token_jest)
- [`KNAPSACK_PRO_CI_NODE_TOTAL`](/jest/reference/#knapsack_pro_ci_node_total)
- [`KNAPSACK_PRO_CI_NODE_INDEX`](/jest/reference/#knapsack_pro_ci_node_index)
- [`KNAPSACK_PRO_TEST_SUITE_TOKEN_JEST`](../reference.md#knapsack_pro_test_suite_token_jest)
- [`KNAPSACK_PRO_CI_NODE_TOTAL`](../reference.md#knapsack_pro_ci_node_total)
- [`KNAPSACK_PRO_CI_NODE_INDEX`](../reference.md#knapsack_pro_ci_node_index)
- In the `matrix` section, list all the `KNAPSACK_PRO_CI_NODE_INDEX`es (from `0` to `KNAPSACK_PRO_CI_NODE_TOTAL-1`).

Remember to configure the YAML file path on Codefresh: _Pipelines > Settings (cog icon next to the pipeline) > Workflow Tab (horizontal menu on the top) > Path to YAML > `./.codefresh/codefresh.yml`_.
Expand Down Expand Up @@ -385,10 +385,10 @@ Generate [API tokens](https://knapsackpro.com/dashboard?utm_source=docs_knapsack

Define in `.github/workflows/main.yaml`:

- [`KNAPSACK_PRO_TEST_SUITE_TOKEN_JEST`](/jest/reference/#knapsack_pro_test_suite_token_jest) in _GitHub Settings > Secrets_ as described in [GitHub Actions' docs](https://docs.github.com/en/actions/security-guides/encrypted-secrets#creating-encrypted-secrets-for-a-repository).
- [`KNAPSACK_PRO_CI_NODE_TOTAL`](/jest/reference/#knapsack_pro_ci_node_total) using the [`matrix` property](https://help.github.com/en/articles/workflow-syntax-for-github-actions#jobsjob_idstrategymatrix)
- [`KNAPSACK_PRO_CI_NODE_INDEX`](/jest/reference/#knapsack_pro_ci_node_index) using the [`matrix` property](https://help.github.com/en/articles/workflow-syntax-for-github-actions#jobsjob_idstrategymatrix)
- [`KNAPSACK_PRO_FIXED_QUEUE_SPLIT=true`](/jest/reference/#knapsack_pro_fixed_queue_split)
- [`KNAPSACK_PRO_TEST_SUITE_TOKEN_JEST`](../reference.md#knapsack_pro_test_suite_token_jest) in _GitHub Settings > Secrets_ as described in [GitHub Actions' docs](https://docs.github.com/en/actions/security-guides/encrypted-secrets#creating-encrypted-secrets-for-a-repository).
- [`KNAPSACK_PRO_CI_NODE_TOTAL`](../reference.md#knapsack_pro_ci_node_total) using the [`matrix` property](https://help.github.com/en/articles/workflow-syntax-for-github-actions#jobsjob_idstrategymatrix)
- [`KNAPSACK_PRO_CI_NODE_INDEX`](../reference.md#knapsack_pro_ci_node_index) using the [`matrix` property](https://help.github.com/en/articles/workflow-syntax-for-github-actions#jobsjob_idstrategymatrix)
- [`KNAPSACK_PRO_FIXED_QUEUE_SPLIT=true`](../reference.md#knapsack_pro_fixed_queue_split)

Here's an example config:

Expand Down Expand Up @@ -459,9 +459,9 @@ See also [how to configure running parallel CI nodes in GitLab](https://docs.git

Define in `.gitlab-ci.yml`:

- [`KNAPSACK_PRO_TEST_SUITE_TOKEN_JEST`](/jest/reference/#knapsack_pro_test_suite_token_jest)
- [`KNAPSACK_PRO_CI_NODE_TOTAL`](/jest/reference/#knapsack_pro_ci_node_total)
- [`KNAPSACK_PRO_CI_NODE_INDEX`](/jest/reference/#knapsack_pro_ci_node_index)
- [`KNAPSACK_PRO_TEST_SUITE_TOKEN_JEST`](../reference.md#knapsack_pro_test_suite_token_jest)
- [`KNAPSACK_PRO_CI_NODE_TOTAL`](../reference.md#knapsack_pro_ci_node_total)
- [`KNAPSACK_PRO_CI_NODE_INDEX`](../reference.md#knapsack_pro_ci_node_index)

Here's an example configuration for 2 parallel jobs:

Expand Down Expand Up @@ -503,7 +503,7 @@ Generate [API tokens](https://knapsackpro.com/dashboard?utm_source=docs_knapsack

Define in `app.json`:

- [`KNAPSACK_PRO_TEST_SUITE_TOKEN_JEST`](/jest/reference/#knapsack_pro_test_suite_token_jest)
- [`KNAPSACK_PRO_TEST_SUITE_TOKEN_JEST`](../reference.md#knapsack_pro_test_suite_token_jest)
- `quantity`: number of parallel dynos
- `test`: the Knapsack Pro command

Expand Down Expand Up @@ -605,7 +605,7 @@ Generate [API tokens](https://knapsackpro.com/dashboard?utm_source=docs_knapsack

Define in `.semaphore/semaphore.yml`:

- [`KNAPSACK_PRO_TEST_SUITE_TOKEN_JEST`](/jest/reference/#knapsack_pro_test_suite_token_jest)
- [`KNAPSACK_PRO_TEST_SUITE_TOKEN_JEST`](../reference.md#knapsack_pro_test_suite_token_jest)
- `parallelism`

Here's an example config:
Expand Down Expand Up @@ -655,10 +655,10 @@ Generate [API tokens](https://knapsackpro.com/dashboard?utm_source=docs_knapsack

Define in `.travis.yml`:

- [`KNAPSACK_PRO_TEST_SUITE_TOKEN_JEST`](/jest/reference/#knapsack_pro_test_suite_token_jest)
- [`KNAPSACK_PRO_CI_NODE_TOTAL`](/jest/reference/#knapsack_pro_ci_node_total)
- [`KNAPSACK_PRO_CI_NODE_INDEX`](/jest/reference/#knapsack_pro_ci_node_index) as [jobs](http://docs.travis-ci.com/user/speeding-up-the-build/#parallelizing-your-builds-across-virtual-machines)
- [`KNAPSACK_PRO_FIXED_QUEUE_SPLIT=true`](/jest/reference/#knapsack_pro_fixed_queue_split)
- [`KNAPSACK_PRO_TEST_SUITE_TOKEN_JEST`](../reference.md#knapsack_pro_test_suite_token_jest)
- [`KNAPSACK_PRO_CI_NODE_TOTAL`](../reference.md#knapsack_pro_ci_node_total)
- [`KNAPSACK_PRO_CI_NODE_INDEX`](../reference.md#knapsack_pro_ci_node_index) as [jobs](http://docs.travis-ci.com/user/speeding-up-the-build/#parallelizing-your-builds-across-virtual-machines)
- [`KNAPSACK_PRO_FIXED_QUEUE_SPLIT=true`](../reference.md#knapsack_pro_fixed_queue_split)

```yaml
script:
Expand Down Expand Up @@ -689,10 +689,10 @@ Generate [API tokens](https://knapsackpro.com/dashboard?utm_source=docs_knapsack

Define the following global environment variables on your CI server:

- [`KNAPSACK_PRO_TEST_SUITE_TOKEN_JEST`](/jest/reference/#knapsack_pro_test_suite_token_jest)
- [`KNAPSACK_PRO_CI_NODE_TOTAL`](/jest/reference/#knapsack_pro_ci_node_total)
- [`KNAPSACK_PRO_CI_NODE_INDEX`](/jest/reference/#knapsack_pro_ci_node_index)
- [`KNAPSACK_PRO_CI_NODE_BUILD_ID`](/jest/reference/#knapsack_pro_ci_node_build_id)
- [`KNAPSACK_PRO_TEST_SUITE_TOKEN_JEST`](../reference.md#knapsack_pro_test_suite_token_jest)
- [`KNAPSACK_PRO_CI_NODE_TOTAL`](../reference.md#knapsack_pro_ci_node_total)
- [`KNAPSACK_PRO_CI_NODE_INDEX`](../reference.md#knapsack_pro_ci_node_index)
- [`KNAPSACK_PRO_CI_NODE_BUILD_ID`](../reference.md#knapsack_pro_ci_node_build_id)

<Tabs>
<TabItem value="node-1" label="Node 1">
Expand Down
4 changes: 2 additions & 2 deletions docusaurus/docs/jest/reference.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ You can pass all the [supported Jest CLI options](https://jestjs.io/docs/en/cli#
$(npm bin)/knapsack-pro-jest --debug
```

You can also pass options to Node with environment variables (e.g., [`--max_old_space_size`](/jest/troubleshooting/#javascript-heap-out-of-memory)).
You can also pass options to Node with environment variables (e.g., [`--max_old_space_size`](troubleshooting.md#javascript-heap-out-of-memory)).

## `KNAPSACK_PRO_BRANCH`

Expand Down Expand Up @@ -75,7 +75,7 @@ The directory where Jest should output its coverage files.

Default: `undefined`

Read more on [Generate code coverage reports](https://docs.knapsackpro.com/jest/cookbook/#generate-code-coverage-reports).
Read more on [Generate code coverage reports](cookbook.md#generate-code-coverage-reports).

## `KNAPSACK_PRO_ENDPOINT` (Internal)

Expand Down
2 changes: 1 addition & 1 deletion docusaurus/docs/jest/troubleshooting.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -49,4 +49,4 @@ $(npm bin)/knapsack-pro-jest --runInBand

## No tests are executed (or `test_files: [ 'parameter is required' ]`)

Make sure [`KNAPSACK_PRO_TEST_FILE_PATTERN`](/jest/reference/#knapsack_pro_test_file_pattern) is correct.
Make sure [`KNAPSACK_PRO_TEST_FILE_PATTERN`](reference.md#knapsack_pro_test_file_pattern) is correct.
Loading

0 comments on commit cfa351e

Please sign in to comment.