diff --git a/docs/api/examples/external-events.mdx b/docs/api/examples/external-events.mdx index 34f95fc..f31b816 100644 --- a/docs/api/examples/external-events.mdx +++ b/docs/api/examples/external-events.mdx @@ -44,7 +44,7 @@ Uploading a definition of a single External Source Type (`ExampleSource`) and a ``` ### Creating an External Source -To upload External Sources, users should POST to the `/uploadExternalSource` route in `aerie-gateway`. +To upload External Sources, users should POST to the `/uploadExternalSource` route in `plandev-gateway`. This endpoint expects data provided in [`multipart/form-data` format](https://www.ietf.org/rfc/rfc2388.txt). diff --git a/docs/api/introduction.mdx b/docs/api/introduction.mdx index c239215..858c333 100644 --- a/docs/api/introduction.mdx +++ b/docs/api/introduction.mdx @@ -149,7 +149,7 @@ Set it to the following: { "headers": { "x-hasura-admin-secret": "", - "x-hasura-user-id": "", + "x-hasura-user-id": "", "x-hasura-role": "viewer" } } @@ -188,7 +188,7 @@ const res = await altair.helpers.request( 'POST', '/auth/login', // AUTH ENDPOINT OF THE DEPLOYMENT { - body: { username: '', password: '' }, // CREDENTIALS TO LOG IN AS + body: { username: '', password: '' }, // CREDENTIALS TO LOG IN AS headers: { 'Content-Type': 'application/json' }, }, ); @@ -222,13 +222,13 @@ const res = await altair.helpers.request( 'POST', '/auth/login', // AUTH ENDPOINT OF THE DEPLOYMENT { - body: { username: '', password: '' }, // CREDENTIALS TO LOG IN AS + body: { username: '', password: '' }, // CREDENTIALS TO LOG IN AS headers: { 'Content-Type': 'application/json' }, }, ); ``` -Replace `` and `` with the username and password you use to sign in to PlanDev. +Replace `` and `` with the username and password you use to sign in to PlanDev. :::info Setting Your Role By default, you will make queries using the `viewer` role. If you want to use a different role, @@ -258,7 +258,7 @@ import json import os import requests -token = os.getenv('AERIE_TOKEN') +token = os.getenv('PLANDEV_TOKEN') response = requests.post( url='http://localhost:8080/v1/graphql', # Change from 'localhost' as needed. diff --git a/docs/command-expansion/template-expansion/authoring-templates.mdx b/docs/command-expansion/template-expansion/authoring-templates.mdx index 6d9f981..abb7862 100644 --- a/docs/command-expansion/template-expansion/authoring-templates.mdx +++ b/docs/command-expansion/template-expansion/authoring-templates.mdx @@ -262,7 +262,7 @@ Unflattened: 1,2,3.5,string; Flattened: [1 2 3.5 string] --- -Putting this all together in AERIE, we might have the following: +Putting this all together in Plandev, we might have the following:
PlanDev UI - Template With Helpers diff --git a/docs/command-expansion/template-expansion/introduction.md b/docs/command-expansion/template-expansion/introduction.md index 25f8a93..16e4f7d 100644 --- a/docs/command-expansion/template-expansion/introduction.md +++ b/docs/command-expansion/template-expansion/introduction.md @@ -43,17 +43,17 @@ C DP_PRIORITIZE "STRING" 5 ``` ## Configuration -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. +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. :::caution Sequence templating and EDSL rules are exclusive of each other. They cannot coexist in the same instance of PlanDev. ::: -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. +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. -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. +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. -If you are accessing `aerie` remotely via an externally managed host, please reach out to that system's administrator about changing the deployment configuration. +If you are accessing PlanDev remotely via an externally managed host, please reach out to that system's administrator about changing the deployment configuration. ## Sequence Templates in PlanDev 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: diff --git a/docs/deployment/advanced-ui-custom-base-path.md b/docs/deployment/advanced-ui-custom-base-path.md index d7fbee1..2aaee0f 100644 --- a/docs/deployment/advanced-ui-custom-base-path.md +++ b/docs/deployment/advanced-ui-custom-base-path.md @@ -1,10 +1,10 @@ # Advanced - UI Custom Base Path -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. +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. ### Building -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). +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). ```sh git clone https://github.com/NASA-AMMOS/plandev-ui.git @@ -12,21 +12,21 @@ This document lists the instructions for building an aerie-ui Docker image with npm install ``` - 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: + 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: ```sh git checkout tags/v1.0.0 -b v1.0.0 ``` -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`. +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`. -3. Build the aerie-ui. +3. Build the plandev-ui. ```sh npm run build ``` -4. Build the aerie-ui Docker image. Change the tag as necessary. For example we tag the image here with `aerie-ui`: +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: ```sh docker build -t aerie-ui . @@ -52,8 +52,8 @@ docker rmi aerie-ui ### References -1. [aerie-ui Developer.md](https://github.com/NASA-AMMOS/plandev-ui/blob/develop/docs/DEVELOPER.md) -1. [aerie-ui Deployment.md](https://github.com/NASA-AMMOS/plandev-ui/blob/develop/docs/DEPLOYMENT.md) +1. [plandev-ui Developer.md](https://github.com/NASA-AMMOS/plandev-ui/blob/develop/docs/DEVELOPER.md) +1. [plandev-ui Deployment.md](https://github.com/NASA-AMMOS/plandev-ui/blob/develop/docs/DEPLOYMENT.md) ### Svelte Kit Issues diff --git a/docs/deployment/introduction.md b/docs/deployment/introduction.md index f944650..f68e6fb 100644 --- a/docs/deployment/introduction.md +++ b/docs/deployment/introduction.md @@ -53,6 +53,8 @@ The following is a list of all of the required PlanDev services, their associate | [aerie-scheduler-worker][scheduler-worker] | Worker for executing scheduling goals | 27189 | ❌ | | [aerie-sequencing][sequencing] | Service for sequence generation and management | 27184 | ❌ | +By convention, these containers use our legacy `aerie-` naming scheme, & will be renamed to `plandev-` in a future update + ## System Requirements ### Software @@ -82,7 +84,7 @@ Note these numbers are lower bounds. You will need to scale PlanDev based on you ## Defect Reporting Procedure -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. +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. [gateway]: https://github.com/orgs/NASA-AMMOS/packages/container/package/aerie-gateway [hasura]: https://github.com/orgs/NASA-AMMOS/packages/container/package/aerie-hasura diff --git a/docs/overview/aerie-renamed-to-plandev.mdx b/docs/overview/aerie-renamed-to-plandev.mdx deleted file mode 100644 index 21fabdb..0000000 --- a/docs/overview/aerie-renamed-to-plandev.mdx +++ /dev/null @@ -1,14 +0,0 @@ -# Aerie renamed to PlanDev - -This product was **formerly known as Aerie and is now named PlanDev & SeqDev**. -While we've updated most documentation and external references, some legacy mentions of the old product name may remain as we complete the transition. - -What to know: - -* The planning product, including modeling, simulation, scheduling and constraint-checking, is now named **PlanDev**. -* The sequencing product, including the sequence editor, workspaces, and actions, is now named **SeqDev**. -* All features and functionality remain the same. -* Currently, repository names, package names and other internal code references will retain their existing names, and deployment/migration procedures have not changed. -* In a future release, our repository and/or package names may change. If so, this will be communicated to users via release notes and normal communication channels. - -You are already on our new docs page, which is https://nasa-ammos.github.io/plandev-docs/. Links to pages in the old Aerie docs will be redirected to their new PlanDev equivalent, but it is a good idea to update any links in your documents when possible. diff --git a/docs/overview/design/software-design-document.mdx b/docs/overview/design/software-design-document.mdx index ec34d04..0331938 100644 --- a/docs/overview/design/software-design-document.mdx +++ b/docs/overview/design/software-design-document.mdx @@ -535,7 +535,7 @@ configuration file. PlanDev provides authentication and authorization capabilities via the Common Access Manager. Currently, authentication requests from the -PlanDev UI are proxied through the aerie-ui-server. It is prudent that +PlanDev UI are proxied through the aerie-ui service. It is prudent that PlanDev not handle (proxy/store) any credential information, for any duration of time. As a result, PlanDev authentication will soon be amended so requests for an authentication token are made directly to a diff --git a/docs/overview/plandev-seqdev-naming.mdx b/docs/overview/plandev-seqdev-naming.mdx new file mode 100644 index 0000000..5150574 --- /dev/null +++ b/docs/overview/plandev-seqdev-naming.mdx @@ -0,0 +1,12 @@ +## PlanDev & SeqDev Naming + +As new mission communities have joined PlanDev, we've evolved our product focus and naming. What you need to know: + +What to know: + +* The planning tool is now named **PlanDev** and the sequencing tool is now named **SeqDev** +* Most repositories have been renamed, and the rest will be renamed soon. The repository code structure has not changed +* Published code packages (NPM, Java, and Docker images) still retain their **old** names but will be renamed in a future version +* Changes affecting your code will be announced in advance with upgrade guidance + +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. diff --git a/docs/planning/advanced-incons.mdx b/docs/planning/advanced-incons.mdx index e7dfb43..c3133fa 100644 --- a/docs/planning/advanced-incons.mdx +++ b/docs/planning/advanced-incons.mdx @@ -112,8 +112,8 @@ The most important element of this JSON is `filename`. It contains the name of t ### Step 3: Use the Incons in Simulation -Finally, open the Simulation Configuration panel and set the `inconsPath` argument to `/`, -where `` is the path to where the `aerie_file_store` volume is mounted in Merlin, +Finally, open the Simulation Configuration panel and set the `inconsPath` argument to `/`, +where `` is the path to where the `aerie_file_store` volume is mounted in Merlin, and `` is the value of `"filename"` from the earlier JSON from the Gateway. By default, `` is `merlin_file_store`. diff --git a/docs/scheduling-and-constraints/procedural/scheduling/examples.mdx b/docs/scheduling-and-constraints/procedural/scheduling/examples.mdx index 7fa99cb..9d0301c 100644 --- a/docs/scheduling-and-constraints/procedural/scheduling/examples.mdx +++ b/docs/scheduling-and-constraints/procedural/scheduling/examples.mdx @@ -176,7 +176,7 @@ public record ExternalEventsSourceQueryGoal() implements Goal { } ``` -After running it, we get the following result in AERIE: +After running it, we get the following result in PlanDev: import results from './assets/results.png'; diff --git a/docs/upgrade-guides/3-8-1-to-4-0-0.md b/docs/upgrade-guides/3-8-1-to-4-0-0.md index 55e0a6d..96aec55 100644 --- a/docs/upgrade-guides/3-8-1-to-4-0-0.md +++ b/docs/upgrade-guides/3-8-1-to-4-0-0.md @@ -10,7 +10,7 @@ What to know: * The sequencing product, including the sequence editor, workspaces, and actions, is now named **SeqDev**. * All features and functionality remain the same. * As of v4.0.0, repository names, package names and other internal code references will retain their existing names, and deployment/migration procedures have not changed. -* In a future release, repository and/or package names may change. If so, this will be communicated to users via release notes and normal communication channels. Latest updates can be found on [the "Rename" page](/overview/aerie-renamed-to-plandev/) in the docs. +* In a future release, repository and/or package names may change. If so, this will be communicated to users via release notes and normal communication channels. Latest updates can be found on [the "Naming" page](/overview/plandev-seqdev-naming/) in the docs. You are already on our new docs page, which is https://nasa-ammos.github.io/plandev-docs/. Links to pages in the old Aerie docs will be redirected to their new PlanDev equivalent, but it is a good idea to update any links in your documents when possible. diff --git a/sidebars.js b/sidebars.js index 3a63c84..3877b4e 100644 --- a/sidebars.js +++ b/sidebars.js @@ -75,7 +75,7 @@ const sidebars = { 'overview/design/software-design-document', ], }, - 'overview/aerie-renamed-to-plandev', + 'overview/plandev-seqdev-naming', ], }, {