Merge pull request #397 from dhis2/docs-improve

docs: tiny change to fix pathing
dhis2 · Nov 16, 2023 · 785a91c · 785a91c
2 parents 509afd7 + 12311e9
commit 785a91c
Show file tree

Hide file tree

Showing 7 changed files with 26 additions and 8 deletions.
diff --git 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
@@ -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
@@ -1,12 +1,12 @@
-# Network shim - Developer documentation
+# Network shim
 
 The network shim consists of both commands (`@dhis2/cypress-commands`) as well
 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
@@ -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
@@ -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
@@ -0,0 +1,18 @@
+<!DOCTYPE html>
+<html>
+    <head>
+        <meta charset="UTF-8" />
+        <title>Redirecting to Developer Portal</title>
+    </head>
+    <body>
+        <p>Redirecting to <a id="url" href="#">Developer Portal</a>...</p>
+
+        <script>
+            const hash = window.location.hash.substring(2)
+
+            const newUrl = `https://developers.dhis2.org/docs/cli/cypress/${hash}`
+            document.getElementById('url').href = newUrl
+            window.location.href = newUrl
+        </script>
+    </body>
+</html>
diff --git 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",