Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: replace all references to "parenting-app-ui" in the docs with "open-app-builder", including links to online documentation site #2332

Merged
merged 2 commits into from
Jun 6, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/IDEMSInternational/parenting-app-ui.git)
[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/IDEMSInternational/open-app-builder.git)

# Parenting App UI
# Open App Builder

[Online Documentation](https://idemsinternational.github.io/parenting-app-ui/)
[Online Documentation](https://idemsinternational.github.io/open-app-builder/)

# Quickstart

Expand All @@ -24,13 +24,13 @@

### Download the repo with binary assets
```
$ git lfs clone https://github.com/IDEMSInternational/parenting-app-ui.git
$ git lfs clone https://github.com/IDEMSInternational/open-app-builder.git
```
Note - if you do a regular git clone, you can always run `git lfs fetch --all` later to sync assets

### Install required dependencies
```
$ cd parenting-app-ui
$ cd open-app-builder
$ yarn install
```
Note - you may have to do this from time to time when content is updated)
Expand All @@ -45,7 +45,7 @@ yarn workflow deployment set
```
This will present an interactive list of deployments to select from.

See [Deployment Documentation](https://idemsinternational.github.io/parenting-app-ui/developers/deployments/) for information about creating and configuring deployments.
See [Deployment Documentation](https://idemsinternational.github.io/open-app-builder/developers/deployments/) for information about creating and configuring deployments.

## Running locally

Expand All @@ -57,8 +57,8 @@ This will start a local server and serve the app in your browser on http://local

# For Content Coders

Please see [Quickstart Authors](https://idemsinternational.github.io/parenting-app-ui/authors/quickstart/)
Please see [Quickstart Authors](https://idemsinternational.github.io/open-app-builder/authors/quickstart/)

# For Developers

Please see [Quickstart Developers](https://idemsinternational.github.io/parenting-app-ui/developers/quickstart/)
Please see [Quickstart Developers](https://idemsinternational.github.io/open-app-builder/developers/quickstart/)
2 changes: 1 addition & 1 deletion documentation/docs/authors/advanced/overrides.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,4 +51,4 @@ It is also possible to replace any other flow type during sync and build by spec
This can be useful in cases where multiple apps share some of the same core content, and want to only apply a number of replacements/additions.

!!! example "Experimental"
See open issue [2081](https://github.com/IDEMSInternational/parenting-app-ui/issues/2081) for proposals to add multiple data sources to make this type of override system more easy to implement
See open issue [2081](https://github.com/IDEMSInternational/open-app-builder/issues/2081) for proposals to add multiple data sources to make this type of override system more easy to implement
2 changes: 1 addition & 1 deletion documentation/docs/authors/notifications.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,4 +63,4 @@ Notifications are automatically evaluated and scheduled on app start
!!! warning
When the app is not in active use sync timers pause and so no new notifications will be evaluated. That means that if the user closes the app

There is currently no workaround for this unfortunately except for reducing the re-schedule sync timer, however if this is required than it is suggested to [create an issue](https://github.com/IDEMSInternational/parenting-app-ui/issues/new/choose) for the feature (likely best handled by a trigger that can be called from authoring).
There is currently no workaround for this unfortunately except for reducing the re-schedule sync timer, however if this is required than it is suggested to [create an issue](https://github.com/IDEMSInternational/open-app-builder/issues/new/choose) for the feature (likely best handled by a trigger that can be called from authoring).
4 changes: 2 additions & 2 deletions documentation/docs/developers/deployments.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,9 +56,9 @@ export default config;
```
This configuration provides a minimal set of options to override the default header and sidemenu text, as well as configuring a remote google_drive data source (more information below)

A full list of general configuration options can be found in [packages/data-models/deployment.model.ts](https://github.com/IDEMSInternational/parenting-app-ui/blob/master/packages/data-models/deployment.model.ts)
A full list of general configuration options can be found in [packages/data-models/deployment.model.ts](https://github.com/IDEMSInternational/open-app-builder/blob/master/packages/data-models/deployment.model.ts)

A full list of app_config and their default values can be found in [packages/data-models/appConfig.ts](https://github.com/IDEMSInternational/parenting-app-ui/blob/master/packages/data-models/appConfig.ts)
A full list of app_config and their default values can be found in [packages/data-models/appConfig.ts](https://github.com/IDEMSInternational/open-app-builder/blob/master/packages/data-models/appConfig.ts)

Any configuration changes can be applied by setting the deployment
```
Expand Down
2 changes: 1 addition & 1 deletion documentation/docs/developers/device-testing.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## Generate apk
A custom github action exists that can be used to trigger the building of android APKs from a given repo branch. Visit the action url and click Run workflow to initiate a build
https://github.com/IDEMSInternational/parenting-app-ui/actions/workflows/trigger-build.yml
https://github.com/IDEMSInternational/open-app-builder/actions/workflows/trigger-build.yml

![](./images/device-testing-1.png)

Expand Down
2 changes: 1 addition & 1 deletion documentation/docs/developers/in-app-updates.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ npx cap open android
3. Create a debug build from android studio menu (assumes google.json populated locally)
_Build -> Build Bundles / APKs -> Build Bundle_

It should prompt a message on complete to locate the bundle, e.g. `...\parenting-app-ui\android\app\build\outputs\bundle\debug`
It should prompt a message on complete to locate the bundle, e.g. `...\open-app-builder\android\app\build\outputs\bundle\debug`

4. Upload to [internal app sharing](https://play.google.com/console/internal-app-sharing) (each user maintains their own list of uploaded apps, so you won't be able to see what others have uploaded)

Expand Down
2 changes: 1 addition & 1 deletion documentation/docs/developers/web-previews.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ on:

jobs:
web_preview:
uses: IDEMSInternational/parenting-app-ui/.github/workflows/reusable-deploy-web-preview.yml@master
uses: IDEMSInternational/open-app-builder/.github/workflows/reusable-deploy-web-preview.yml@master
secrets: inherit
```

Expand Down
4 changes: 2 additions & 2 deletions documentation/docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,13 +18,13 @@

### Download the repo with binary assets
```
$ git lfs clone https://github.com/IDEMSInternational/parenting-app-ui.git
$ git lfs clone https://github.com/IDEMSInternational/open-app-builder.git
```
Note - if you do a regular git clone, you can always run `git lfs fetch --all` later to sync assets

### Install required dependencies
```
$ cd parenting-app-ui
$ cd open-app-builder
$ yarn install
```
Note - you may have to do this from time to time when content is updated)
Expand Down
2 changes: 1 addition & 1 deletion documentation/docs/questions/parameters_styles.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

_Asked on 10 February 2022_

The `parameter_list` takes only parameters that are specifically defined by us for every specific component. As such, these are going to be pretty impossible for you to guess without documentation. For what it's worth, [this file](https://github.com/IDEMSInternational/parenting-app-ui/blob/master/documentation/docs/authors/template-component-parameter-list.md) is the closest thing to documentation of those parameters that we have at the moment.
The `parameter_list` takes only parameters that are specifically defined by us for every specific component. As such, these are going to be pretty impossible for you to guess without documentation. For what it's worth, [this file](https://github.com/IDEMSInternational/open-app-builder/blob/master/documentation/docs/authors/template-component-parameter-list.md) is the closest thing to documentation of those parameters that we have at the moment.

Instead, the `style_list` does indeed interpret CSS directly. My knowledge of CSS is limited as well so I can't be of much help here, but [this documentation website](https://www.w3schools.com/cssref/default.asp) has proven handy to me in the past.

Expand Down
2 changes: 1 addition & 1 deletion documentation/mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ theme:
accent: a mber
font:
text: "Open Sans"
repo_url: https://github.com/IDEMSInternational/parenting-app-ui
repo_url: https://github.com/IDEMSInternational/open-app-builder
edit_uri: edit/master/documentation/docs/

nav:
Expand Down
Loading