Skip to content

Commit ca55263

Browse files
committed
updates to plandev renaming disclaimer & other minor updates to fix names
1 parent 82e6b6f commit ca55263

13 files changed

Lines changed: 40 additions & 40 deletions

File tree

docs/api/examples/external-events.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ Uploading a definition of a single External Source Type (`ExampleSource`) and a
4444
```
4545

4646
### Creating an External Source
47-
To upload External Sources, users should POST to the `/uploadExternalSource` route in `aerie-gateway`.
47+
To upload External Sources, users should POST to the `/uploadExternalSource` route in `plandev-gateway`.
4848

4949
This endpoint expects data provided in [`multipart/form-data` format](https://www.ietf.org/rfc/rfc2388.txt).
5050

docs/api/introduction.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -149,7 +149,7 @@ Set it to the following:
149149
{
150150
"headers": {
151151
"x-hasura-admin-secret": "<YOUR_ADMIN_SECRET>",
152-
"x-hasura-user-id": "<YOUR_AERIE_USERNAME>",
152+
"x-hasura-user-id": "<YOUR_PLANDEV_USERNAME>",
153153
"x-hasura-role": "viewer"
154154
}
155155
}
@@ -188,7 +188,7 @@ const res = await altair.helpers.request(
188188
'POST',
189189
'/auth/login', // AUTH ENDPOINT OF THE DEPLOYMENT
190190
{
191-
body: { username: '<YOUR_AERIE_USERNAME>', password: '<YOUR_AERIE_PASSWORD>' }, // CREDENTIALS TO LOG IN AS
191+
body: { username: '<YOUR_PLANDEV_USERNAME>', password: '<YOUR_PLANDEV_PASSWORD>' }, // CREDENTIALS TO LOG IN AS
192192
headers: { 'Content-Type': 'application/json' },
193193
},
194194
);
@@ -222,13 +222,13 @@ const res = await altair.helpers.request(
222222
'POST',
223223
'/auth/login', // AUTH ENDPOINT OF THE DEPLOYMENT
224224
{
225-
body: { username: '<YOUR_AERIE_USERNAME>', password: '<YOUR_AERIE_PASSWORD>' }, // CREDENTIALS TO LOG IN AS
225+
body: { username: '<YOUR_PLANDEV_USERNAME>', password: '<YOUR_PLANDEV_PASSWORD>' }, // CREDENTIALS TO LOG IN AS
226226
headers: { 'Content-Type': 'application/json' },
227227
},
228228
);
229229
```
230230

231-
Replace `<YOUR_AERIE_USERNAME>` and `<YOUR_AERIE_PASSWORD>` with the username and password you use to sign in to PlanDev.
231+
Replace `<YOUR_PLANDEV_USERNAME>` and `<YOUR_PLANDEV_PASSWORD>` with the username and password you use to sign in to PlanDev.
232232

233233
:::info Setting Your Role
234234
By default, you will make queries using the `viewer` role. If you want to use a different role,
@@ -258,7 +258,7 @@ import json
258258
import os
259259
import requests
260260

261-
token = os.getenv('AERIE_TOKEN')
261+
token = os.getenv('PLANDEV_TOKEN')
262262

263263
response = requests.post(
264264
url='http://localhost:8080/v1/graphql', # Change from 'localhost' as needed.

docs/command-expansion/template-expansion/authoring-templates.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -262,7 +262,7 @@ Unflattened: 1,2,3.5,string; Flattened: [1 2 3.5 string]
262262

263263
---
264264

265-
Putting this all together in AERIE, we might have the following:
265+
Putting this all together in Plandev, we might have the following:
266266

267267
<figure>
268268
<img alt="PlanDev UI - Template With Helpers" src={templateHelpers} />

docs/command-expansion/template-expansion/introduction.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -43,17 +43,17 @@ C DP_PRIORITIZE "STRING" 5
4343
```
4444

4545
## 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.
4747

4848
:::caution
4949
Sequence templating and EDSL rules are exclusive of each other. They cannot coexist in the same instance of PlanDev.
5050
:::
5151

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.
5353

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.
5555

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.
5757

5858
## Sequence Templates in PlanDev
5959
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:

docs/deployment/advanced-ui-custom-base-path.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,32 @@
11
# Advanced - UI Custom Base Path
22

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.
44

55
### Building
66

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).
88

99
```sh
1010
git clone https://github.com/NASA-AMMOS/plandev-ui.git
1111
cd aerie-ui
1212
npm install
1313
```
1414

15-
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:
1616

1717
```sh
1818
git checkout tags/v1.0.0 -b v1.0.0
1919
```
2020

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`.
2222

23-
3. Build the aerie-ui.
23+
3. Build the plandev-ui.
2424

2525
```sh
2626
npm run build
2727
```
2828

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:
3030

3131
```sh
3232
docker build -t aerie-ui .
@@ -52,8 +52,8 @@ docker rmi aerie-ui
5252

5353
### References
5454

55-
1. [aerie-ui Developer.md](https://github.com/NASA-AMMOS/plandev-ui/blob/develop/docs/DEVELOPER.md)
56-
1. [aerie-ui Deployment.md](https://github.com/NASA-AMMOS/plandev-ui/blob/develop/docs/DEPLOYMENT.md)
55+
1. [plandev-ui Developer.md](https://github.com/NASA-AMMOS/plandev-ui/blob/develop/docs/DEVELOPER.md)
56+
1. [plandev-ui Deployment.md](https://github.com/NASA-AMMOS/plandev-ui/blob/develop/docs/DEPLOYMENT.md)
5757

5858
### Svelte Kit Issues
5959

docs/deployment/introduction.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,8 @@ The following is a list of all of the required PlanDev services, their associate
5353
| [aerie-scheduler-worker][scheduler-worker] | Worker for executing scheduling goals | 27189 ||
5454
| [aerie-sequencing][sequencing] | Service for sequence generation and management | 27184 ||
5555

56+
By convention, these containers use our legacy `aerie-` naming scheme, & will be renamed to `plandev-` in a future update
57+
5658
## System Requirements
5759

5860
### Software
@@ -82,7 +84,7 @@ Note these numbers are lower bounds. You will need to scale PlanDev based on you
8284

8385
## Defect Reporting Procedure
8486

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.
8688

8789
[gateway]: https://github.com/orgs/NASA-AMMOS/packages/container/package/aerie-gateway
8890
[hasura]: https://github.com/orgs/NASA-AMMOS/packages/container/package/aerie-hasura

docs/overview/aerie-renamed-to-plandev.mdx

Lines changed: 0 additions & 14 deletions
This file was deleted.

docs/overview/design/software-design-document.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -535,7 +535,7 @@ configuration file.
535535

536536
PlanDev provides authentication and authorization capabilities via the
537537
Common Access Manager. Currently, authentication requests from the
538-
PlanDev UI are proxied through the aerie-ui-server. It is prudent that
538+
PlanDev UI are proxied through the aerie-ui service. It is prudent that
539539
PlanDev not handle (proxy/store) any credential information, for any
540540
duration of time. As a result, PlanDev authentication will soon be
541541
amended so requests for an authentication token are made directly to a
Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
## PlanDev & SeqDev Naming
2+
3+
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.

docs/planning/advanced-incons.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -112,8 +112,8 @@ The most important element of this JSON is `filename`. It contains the name of t
112112

113113
### Step 3: Use the Incons in Simulation
114114

115-
Finally, open the Simulation Configuration panel and set the `inconsPath` argument to `<path-to-aerie-file-store>/<filename>`,
116-
where `<path-to-aerie-file-store>` is the path to where the `aerie_file_store` volume is mounted in Merlin,
115+
Finally, open the Simulation Configuration panel and set the `inconsPath` argument to `<path-to-file-store>/<filename>`,
116+
where `<path-to-file-store>` is the path to where the `aerie_file_store` volume is mounted in Merlin,
117117
and `<filename>` is the value of `"filename"` from the earlier JSON from the Gateway.
118118

119119
By default, `<path-to-aerie-file-store>` is `merlin_file_store`.

0 commit comments

Comments
 (0)