Skip to content

Commit 149109b

Browse files
authored
Merge pull request #1419 from dhis2/update-dhis2-nu-links
docs: update dhis2.nu links
2 parents d6b5193 + 41330b4 commit 149109b

File tree

11 files changed

+17
-17
lines changed

11 files changed

+17
-17
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ A query REPL platform application is also available at `./examples/query-playgro
2121

2222
Running `yarn build` at root will automatically update the example app's copy, and running `yarn start` will build the runtime and then start the example.
2323

24-
A [`DHIS2 App Platform`](https://platform.dhis2.nu) example is available at [./examples/query-playground](./examples/query-playground). This is a full, deployable DHIS2 application and a live standalone version is available at [every play instance](https://play.dhis2.org), such as the `dev` instance [play.dhis2.org/dev](https://play.dhis2.org/dev/api/apps/query-playground/index.html).
24+
A [`DHIS2 App Platform`](https://developers.dhis2.org/docs/app-platform/getting-started) example is available at [./examples/query-playground](./examples/query-playground). This is a full, deployable DHIS2 application and a live standalone version is available at [every play instance](https://play.dhis2.org).
2525

2626
## Release
2727

docs/advanced/offline/CacheableSections.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Cacheable sections
22

3-
> This feature can only be used when PWA is enabled in `d2.config.js`. See the [App Platform docs](https://platform.dhis2.nu/#/pwa/pwa) for more information.
3+
> This feature can only be used when PWA is enabled in `d2.config.js`. See the [App Platform docs](https://developers.dhis2.org/docs/app-platform/pwa/) for more information.
44
55
The [`useCacheableSection` hook](#usecacheablesection-api) and the [`CacheableSection` component](#cacheablesection-api) provide the controls for the section and the wrapper for the section, respectively. The [`useCachedSections` hook](#usecachedsections-api) returns a list of sections that are stored in the cache and a function that can delete them.
66

@@ -10,7 +10,7 @@ To see a good example of these functions' APIs and their usage, see `SectionWrap
1010

1111
## How it works
1212

13-
Cacheable sections enable sections of an app to be individually cached offline on demand. Using the `CacheableSection` wrapper and the `useCacheableSection` hook, when a user requests a section to be cached for offline use, the section's component tree will rerender, and the app's service worker will listen to all the network traffic for the component to cache it offline. To avoid caching that components' data before a user requests to do so, you can use the [URL filters feature](https://platform.dhis2.nu/#/pwa/pwa?id=opting-in) in `d2.config.js`.
13+
Cacheable sections enable sections of an app to be individually cached offline on demand. Using the `CacheableSection` wrapper and the `useCacheableSection` hook, when a user requests a section to be cached for offline use, the section's component tree will rerender, and the app's service worker will listen to all the network traffic for the component to cache it offline. To avoid caching that components' data before a user requests to do so, you can use the [URL filters feature](https://developers.dhis2.org/docs/app-platform/pwa/#opting-in) in `d2.config.js`.
1414

1515
Note that, without using these features, an app using offline caching will cache all the data that is requested by user as they use the app without needing to use cacheable sections.
1616

docs/advanced/offline/useDhis2ConnectionStatus.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# useDhis2ConnectionStatus
22

3-
> This feature can only be used when PWA is enabled in `d2.config.js`. See the [App Platform docs](https://platform.dhis2.nu/#/pwa/pwa) for more information.
3+
> This feature can only be used when PWA is enabled in `d2.config.js`. See the [App Platform docs](https://developers.dhis2.org/docs/app-platform/pwa/) for more information.
44
55
This hook is used to detect whether or not the app can connect to the DHIS2 server. This can be useful, for example, to make changes in the UI to prevent the user from taking actions that would cause errors while unable to reach the server.
66

docs/hooks/useAlerts.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,12 @@
44

55
## Alert
66

7-
| Prop | Type | Description |
8-
| --------- | ---------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
9-
| `message` | `string` | The alert message to display |
10-
| `id` | `number` | Can be used as `key` when mapping over `alerts` |
11-
| `remove` | `function` | Call this to remove the `alert` |
12-
| `options` | `object` | A configuration object that matches the props of the alert component, for example [a @dhis2/ui `AlertBar`](https://ui.dhis2.nu/#/api?id=coresrcalertbaralertbarproptypes-object) |
7+
| Prop | Type | Description |
8+
| --------- | ---------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
9+
| `message` | `string` | The alert message to display |
10+
| `id` | `number` | Can be used as `key` when mapping over `alerts` |
11+
| `remove` | `function` | Call this to remove the `alert` |
12+
| `options` | `object` | A configuration object that matches the props of the alert component, for example [a @dhis2/ui `AlertBar`](https://developers.dhis2.org/docs/ui/components/alertbar#props) |
1313

1414
:::info Usage note
1515
The DHIS2 app-shell wraps the app in an `AlertsProvider` and also includes an `Alerts` component which leverages `useAlerts` to show `AlertBars` in an `AlertStack` (`@dhis2/ui` components). So in a typical DHIS2 app the only hook used from the alerts-service is `useAlert`.

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@
5454
"d2": {
5555
"docsite": {
5656
"name": "DHIS2 Application Runtime",
57-
"description": "A singular runtime dependency for applications on the [DHIS2 platform](https://platform.dhis2.nu)"
57+
"description": "A singular runtime dependency for applications on the [DHIS2 platform](https://developers.dhis2.org/docs/app-platform/getting-started)"
5858
}
5959
}
6060
}

runtime/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,4 +22,4 @@ The following must be polyfilled to support older and non-compliant browsers (i.
2222

2323
## Usage
2424

25-
See [the docs](https://runtime.dhis2.nu) for usage and examples
25+
See [the docs](https://developers.dhis2.org/docs/app-runtime/getting-started) for usage and examples

services/alerts/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,4 +8,4 @@ This library is intended for use with the [DHIS2 Application Platform](https://g
88

99
This package is internal to `@dhis2/app-runtime` and generally should not be installed independently.
1010

11-
See [the docs](https://runtime.dhis2.nu) for more.
11+
See [the docs](https://developers.dhis2.org/docs/app-runtime/getting-started) for more.

services/config/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,4 +8,4 @@ This library is intended for use with the [DHIS2 Application Platform](https://g
88

99
This package is internal to `@dhis2/app-runtime` and generally should not be installed independently.
1010

11-
See [the docs](https://runtime.dhis2.nu) for more.
11+
See [the docs](https://developers.dhis2.org/docs/app-runtime/getting-started) for more.

services/data/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,4 +8,4 @@ This library is intended for use with the [DHIS2 Application Platform](https://g
88

99
This package is internal to `@dhis2/app-runtime` and generally should not be installed independently.
1010

11-
See [the docs](https://runtime.dhis2.nu) for more.
11+
See [the docs](https://developers.dhis2.org/docs/app-runtime/getting-started) for more.

services/offline/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,4 +8,4 @@ This library is intended for use with the [DHIS2 Application Platform](https://g
88

99
This package is internal to `@dhis2/app-runtime` and generally should not be installed independently.
1010

11-
See [the docs](https://runtime.dhis2.nu) for more.
11+
See [the docs](https://developers.dhis2.org/docs/app-runtime/getting-started) for more.

0 commit comments

Comments
 (0)