You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/command-expansion/template-expansion/introduction.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -43,17 +43,17 @@ C DP_PRIORITIZE "STRING" 5
43
43
```
44
44
45
45
## Configuration
46
-
In order to use sequence templates instead of the existing Typescript EDSL sequence expansion rules, you need to make a configuration change to your `aerie-ui` container.
46
+
In order to use sequence templates instead of the existing Typescript EDSL sequence expansion rules, you need to make a configuration change to the Plandev UI service.
47
47
48
48
:::caution
49
49
Sequence templating and EDSL rules are exclusive of each other. They cannot coexist in the same instance of PlanDev.
50
50
:::
51
51
52
-
If you are running `aerie-ui` locally, then within the `aerie-ui` directory, navigate to `{aerie-ui path}/.env` and update the variable `PUBLIC_COMMAND_EXPANSION_MODE` to `templating`, instead of its default (`legacy`). Then restart the server process.
52
+
If you are running `plandev-ui` locally from the git repository, then within the `plandev-ui` directory, navigate to `{plandev-ui path}/.env` and update the variable `PUBLIC_COMMAND_EXPANSION_MODE` to `templating`, instead of its default (`legacy`). Then restart the server process.
53
53
54
-
If you are running `aerie` in docker, then within the `aerie` directory, navigate to `{aerie path}/docker-compose.yml`, and update the variable`PUBLIC_COMMAND_EXPANSION_MODE` under the `aerie-ui` container's settings to `templating`, instead of its default (`legacy`). Then, redeploy the container.
54
+
If you are running PlanDev Docker services, then open the `docker-compose.yml` file you are using and update the `PUBLIC_COMMAND_EXPANSION_MODE` under the `aerie-ui` container's settings to `templating`, instead of its default (`legacy`). Then, redeploy the container.
55
55
56
-
If you are accessing `aerie` remotely via an externally managed host, please reach out to that system's administrator about changing the deployment configuration.
56
+
If you are accessing PlanDev remotely via an externally managed host, please reach out to that system's administrator about changing the deployment configuration.
57
57
58
58
## Sequence Templates in PlanDev
59
59
After having enabled sequence templates, you are ready to author your own templates and expand with them. Prior to doing so, however, it might be instructive to provide a brief discussion of what these templates require and how they differ from Typescript expansion rules:
Copy file name to clipboardExpand all lines: docs/deployment/advanced-ui-custom-base-path.md
+8-8Lines changed: 8 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,32 +1,32 @@
1
1
# Advanced - UI Custom Base Path
2
2
3
-
This document lists the instructions for building an aerie-ui Docker image with a [custom base path](https://kit.svelte.dev/docs/configuration#paths). While the default path and resulting application URL are usually a good fit, some installations may choose a custom path to support deployment behind a gateway, to provide consistency with other non-PlanDev applications that the mission is using, or this could be part of a configuration that supports running multiple instances of PlanDev UI on the same machine.
3
+
This document lists the instructions for building a PlanDev UI docker image with a [custom base path](https://kit.svelte.dev/docs/configuration#paths). While the default path and resulting application URL are usually a good fit, some installations may choose a custom path to support deployment behind a gateway, to provide consistency with other non-PlanDev applications that the mission is using, or this could be part of a configuration that supports running multiple instances of PlanDev UI on the same machine.
4
4
5
5
### Building
6
6
7
-
1. Clone the [aerie-ui](https://github.com/NASA-AMMOS/plandev-ui) and install dependencies. Note that [Node LTS](https://nodejs.org/) is required (currently 18.13.0).
7
+
1. Clone the [plandev-ui](https://github.com/NASA-AMMOS/plandev-ui) repository and install dependencies. Note that [Node LTS](https://nodejs.org/) is required (currently 18.13.0).
When you clone aerie-ui the default branch is [develop](https://github.com/NASA-AMMOS/plandev-ui/tree/develop). If you want to build an image from a [specific release](https://github.com/NASA-AMMOS/plandev-ui/releases) you have to checkout the proper tag. For example to checkout [v1.0.0](https://github.com/NASA-AMMOS/plandev-ui/releases/tag/v1.0.0) do:
15
+
When you clone plandev-ui the default branch is [develop](https://github.com/NASA-AMMOS/plandev-ui/tree/develop). If you want to build an image from a [specific release](https://github.com/NASA-AMMOS/plandev-ui/releases) you have to checkout the proper tag. For example to checkout [v1.0.0](https://github.com/NASA-AMMOS/plandev-ui/releases/tag/v1.0.0) do:
16
16
17
17
```sh
18
18
git checkout tags/v1.0.0 -b v1.0.0
19
19
```
20
20
21
-
2. Update [svelte.config.js](https://github.com/NASA-AMMOS/plandev-ui/blob/develop/svelte.config.js) with the [base path](https://github.com/NASA-AMMOS/plandev-ui/blob/develop/svelte.config.js#L9) you want to use. Note that a leading `/` is required. So for example a valid base path is `/aerie`.
21
+
2. Update [svelte.config.js](https://github.com/NASA-AMMOS/plandev-ui/blob/develop/svelte.config.js) with the [base path](https://github.com/NASA-AMMOS/plandev-ui/blob/develop/svelte.config.js#L9) you want to use. Note that a leading `/` is required. So for example a valid base path is `/plandev`.
22
22
23
-
3. Build the aerie-ui.
23
+
3. Build the plandev-ui.
24
24
25
25
```sh
26
26
npm run build
27
27
```
28
28
29
-
4. Build the aerie-ui Docker image. Change the tag as necessary. For example we tag the image here with `aerie-ui`:
29
+
4. Build the UI Docker image. By convention, docker images/containers use the legacy "aerie" name. For example we tag the image here with `aerie-ui`, but you can change this tag:
|[aerie-sequencing][sequencing]| Service for sequence generation and management | 27184 | ❌ |
55
55
56
+
By convention, these containers use our legacy `aerie-` naming scheme, & will be renamed to `plandev-` in a future update
57
+
56
58
## System Requirements
57
59
58
60
### Software
@@ -82,7 +84,7 @@ Note these numbers are lower bounds. You will need to scale PlanDev based on you
82
84
83
85
## Defect Reporting Procedure
84
86
85
-
Defect reports should be sent to: `plandev-support@googlegroups.com`. For chat-based support, please join us on the [NASA-AMMOS Slack](https://join.slack.com/t/nasa-ammos/shared_invite/zt-1mlgmk5c2-MgqVSyKzVRUWrXy87FNqPw), in the `#aerie-users` channel.
87
+
Defect reports should be sent to: `plandev-support@googlegroups.com`. For chat-based support, please join us on the [NASA-AMMOS Slack](https://join.slack.com/t/nasa-ammos/shared_invite/zt-1mlgmk5c2-MgqVSyKzVRUWrXy87FNqPw), in the `#plandev-users` channel.
As new mission communities have joined PlanDev, we've evolved our product focus and naming. What you need to know:
4
+
5
+
What to know:
6
+
7
+
* The planning tool is now named **PlanDev** and the sequencing tool is now named **SeqDev**
8
+
* Most repositories have been renamed, and the rest will be renamed soon. The repository code structure has not changed
9
+
* Published code packages (NPM, Java, and Docker images) still retain their **old** names but will be renamed in a future version
10
+
* Changes affecting your code will be announced in advance with upgrade guidance
11
+
12
+
You are already on our updated docs page, which is https://nasa-ammos.github.io/plandev-docs/. Links to pages in the old docs site will be redirected to their new equivalent, but it is a good idea to update any links in your documents when possible.
0 commit comments