Skip to content

Commit ae58d17

Browse files
authored
chore(docs): fix broken link to old 1.1 docs and other missing files (#2516)
Signed-off-by: Nick Boldt <[email protected]>
1 parent 55bdc74 commit ae58d17

File tree

3 files changed

+12
-4
lines changed

3 files changed

+12
-4
lines changed

docs/e2e-tests/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ yarn playwright install chromium
3535
## Adding a Test
3636

3737
To incorporate a new test case, create a file with a `.spec.ts` extension in the `e2e-tests/playwright/e2e` directory.
38-
The tests within a spec file can run in parallel (by default) or sequentially if using the `.serial` modifier like in [this example](../../e2e-tests/playwright/e2e/github-happy-path.spec.ts). Note that sequential execution is considered a bad practice and is strongly discouraged.
38+
The tests within a spec file can run in parallel (by default) or sequentially if using the `.serial` modifier like in [these examples](../../e2e-tests/playwright/e2e/). Note that sequential execution is considered a bad practice and is strongly discouraged.
3939
To add or edit a test, you should adhere to the [contribution guidelines](./CONTRIBUTING.MD).
4040

4141
## Running the Tests

docs/e2e-tests/examples.md

+5-2
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,12 @@ Some contraints in the current architecture do not facilitate the use of Fixture
77

88
You can see an examples of fixture usage at [github discovery test](../../e2e-tests/playwright/e2e/github-discovery.spec.ts).
99

10-
An example on the before/after approach is the [github happy path](../../e2e-tests/playwright/e2e/github-happy-path.spec.ts), but almoust any test that you will find at e2e will follow this approach.
10+
Some tests use a global page variable `let page: Page;`. This is used to avoid reauthentications on the test due to the current rate limits on github.
1111

12-
Also, note that some test (like [github happy path](../../e2e-tests/playwright/e2e/github-happy-path.spec.ts)) uses a global page variable `let page: Page;`. This is used to avoid reauthentications on the test due to the current rate limits on github.
12+
Examples:
13+
14+
* https://github.com/redhat-developer/rhdh/blob/release-1.5/e2e-tests/playwright/e2e/google-signin-happy-path.spec.ts
15+
* https://github.com/redhat-developer/rhdh/blob/release-1.5/e2e-tests/playwright/e2e/guest-signin-happy-path.spec.ts
1316

1417
## Types of tests
1518

docs/index.md

+6-1
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,7 @@ global:
100100

101101
#### Using RHDH Operator
102102

103-
If you have created the `dynamic-plugins-rhdh` ConfigMap file as described in the [Configuring dynamic plugins with the Red Hat Developer Hub Operator](https://access.redhat.com/documentation/en-us/red_hat_developer_hub/1.1/html-single/administration_guide_for_red_hat_developer_hub/index#configuring-dynamic-plugins-with-the-red-hat-developer-hub-operator) section, add the `analytics-provider-segment` plugin to the list of plugins and set the `plugins.disabled` parameter to `true` to disable telemetry, or `false` to enable it.
103+
If you have created the `dynamic-plugins-rhdh` ConfigMap file, add the `analytics-provider-segment` plugin to the list of plugins and set the `plugins.disabled` parameter to `true` to disable telemetry, or `false` to enable it.
104104

105105
If you have not created the `dynamic-plugins-rhdh` ConfigMap file, create it with the following content:
106106

@@ -126,6 +126,11 @@ spec:
126126
dynamicPluginsConfigMapName: dynamic-plugins-rhdh
127127
```
128128

129+
See these docs for more info:
130+
* https://docs.redhat.com/en/documentation/red_hat_developer_hub/1.4/html-single/configuring_dynamic_plugins/index#installing-ansible-plug-ins-for-red-hat-developer-hub or
131+
* https://docs.redhat.com/en/documentation/red_hat_developer_hub/1.4/html-single/configuring/configuring-the-deployment#configuring-the-deployment
132+
133+
129134
### Customizing Telemetry Destination
130135

131136
By default, the `analytics-provider-segment` plugin is configured to send data to Red Hat. To change the destination that receives telemetry data, set the value of the `SEGMENT_WRITE_KEY` environment variable in your Helm configuration file as shown in the following examples.

0 commit comments

Comments
 (0)