diff --git a/docs/commands/findWithDataTest.md b/docs/commands/findWithDataTest.md index 5dccce89..8651904e 100644 --- a/docs/commands/findWithDataTest.md +++ b/docs/commands/findWithDataTest.md @@ -1,7 +1,7 @@ # findWithDataTest For a detailed explanation how to use the custom syntax, please refer to the -[Custom data test syntax](guides/custom_data_test_syntax) guide. +[Custom data test syntax](../guides/custom-data-test-syntax) guide. ## Arguments diff --git a/docs/commands/getWithDataTest.md b/docs/commands/getWithDataTest.md index 91ac871d..a8622870 100644 --- a/docs/commands/getWithDataTest.md +++ b/docs/commands/getWithDataTest.md @@ -1,7 +1,7 @@ # getWithDataTest For a detailed explanation how to use the custom syntax, please refer to the -[Custom data test syntax](guides/custom_data_test_syntax) guide. +[Custom data test syntax](../guides/custom-data-test-syntax) guide. ## Arguments diff --git a/docs/developer/network-shim.md b/docs/developer/network-shim.md index 6d2b9516..e180c6bd 100644 --- a/docs/developer/network-shim.md +++ b/docs/developer/network-shim.md @@ -1,4 +1,4 @@ -# Network shim - Developer documentation +# Network shim The network shim consists of both commands (`@dhis2/cypress-commands`) as well as a plugin (`@dhis2/cypress-plugins`). @@ -6,7 +6,7 @@ as a plugin (`@dhis2/cypress-plugins`). ## The state of the network shim The JSDocs detail the properties of the state, you can find it in the -[`createState.js`](../../packages/cypress-plugins/src/plugins/networkShim/createState.js). +[`createState.js`](https://github.com/dhis2/cli-utils-cypress/blob/master/packages/cypress-plugins/src/plugins/networkShim/createState.js). The state manages which requests have been made, which of them were static or non-deterministic. It also contains the fixture file names of the recorded @@ -97,4 +97,4 @@ The full test suite, including capture mode on a platform app, can be executed _ yarn cy:local ``` -Information about troubleshooting the platform-app capture-run can be found [here](developer/troubleshooting#executing-a-network-shim-capture-run-in-the-platform-app). +Information about troubleshooting the platform-app capture-run can be found [here](./troubleshooting#executing-a-network-shim-capture-run-in-the-platform-app). diff --git a/docs/guides/enable-auto-login.md b/docs/guides/enable-auto-login.md index 7d6d9549..f690475f 100644 --- a/docs/guides/enable-auto-login.md +++ b/docs/guides/enable-auto-login.md @@ -21,5 +21,5 @@ enableAutoLogin() ### Providing the login data -Please refer to [Adding login credentials](guides/add-login-credentials) and +Please refer to [Adding login credentials](./add-login-credentials) and add the required data for logging in. diff --git a/docs/guides/setting-up-cli-tool.md b/docs/guides/setting-up-cli-tool.md index 5b1e120c..ca825a4e 100644 --- a/docs/guides/setting-up-cli-tool.md +++ b/docs/guides/setting-up-cli-tool.md @@ -60,5 +60,5 @@ some of the others: d2-utils-cypress install cypress-config/all cucumber/all ``` -Please refer to [Adding login credentials](guides/add-login-credentials.md) and +Please refer to [Adding login credentials](./add-login-credentials.md) and add the required data for logging in. diff --git a/docs/index.html b/docs/index.html new file mode 100644 index 00000000..2e8037f6 --- /dev/null +++ b/docs/index.html @@ -0,0 +1,18 @@ + + +
+ +Redirecting to Developer Portal...
+ + + + diff --git a/package.json b/package.json index fd616446..5fc5d19a 100644 --- a/package.json +++ b/package.json @@ -25,7 +25,7 @@ "lint:staged": "d2-style check --staged", "format": "d2-style apply", "format:staged": "d2-style apply --staged", - "docs:build": "d2-utils-docsite build ./docs -o ./dist", + "docs:build": "mkdir -p dist && cp docs/index.html dist/", "docs:start": "d2-utils-docsite serve ./docs -o ./dist", "build": "yarn workspace @dhis2/cypress-commands build", "watch": "yarn workspace @dhis2/cypress-commands build --watch",