Skip to content

Commit

Permalink
Merge pull request #819 from dhis2/docs-improve
Browse files Browse the repository at this point in the history
docs: improve
  • Loading branch information
kabaros committed Nov 6, 2023
2 parents 06cee57 + bf93fb3 commit 3096bc0
Show file tree
Hide file tree
Showing 3 changed files with 20 additions and 3 deletions.
2 changes: 1 addition & 1 deletion docs/config/d2-config-js-reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ The following configuration properties are supported:
| **maxDHIS2Version** | _string_ | | The maximum DHIS2 version the App supports. |
| **coreApp** | _boolean_ | **false** | **ADVANCED** If true, build an app artifact to be included as a root-level core application |
| **standalone** | _boolean_ | **false** | **ADVANCED** If true, do NOT include a static BaseURL in the production app artifact. This includes the `Server` field in the login dialog, which is usually hidden and pre-configured in production. |
| **pwa** | _object_ | | **ADVANCED** Opts into and configures PWA settings for this app. Read more about the options in [the PWA docs](pwa/pwa). |
| **pwa** | _object_ | | **ADVANCED** Opts into and configures PWA settings for this app. Read more about the options in [the PWA docs](../pwa). |

> _Note_: Dynamic defaults above may reference `pkg` (a property of the local `package.json` file) or `config` (another property within `d2.config.js`).
Expand Down
18 changes: 18 additions & 0 deletions docs/index.html
Original file line number Diff line number Diff line change
@@ -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/app-platform/${hash}`
document.getElementById('url').href = newUrl
window.location.href = newUrl
</script>
</body>
</html>
3 changes: 1 addition & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -33,8 +33,7 @@
"pwa-demo": "yarn build:pwa && yarn build:adapter && yarn workspace pwa-app demo",
"start:example": "yarn workspace simple-app start --force",
"start": "yarn build:adapter && yarn start:example",
"docs:serve": "d2-utils-docsite serve ./docs -o ./dist",
"docs:build": "d2-utils-docsite build ./docs -o ./dist",
"docs:build": "mkdir -p dist && cp docs/index.html dist/",
"test:adapter": "yarn workspace @dhis2/app-adapter test",
"test:cli": "yarn workspace @dhis2/cli-app-scripts test",
"test": "yarn test:adapter && yarn test:cli"
Expand Down

0 comments on commit 3096bc0

Please sign in to comment.