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: .github/ISSUE_TEMPLATE/2-feature_request.yml
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -5,7 +5,7 @@ body:
5
5
- type: markdown
6
6
attributes:
7
7
value: |
8
-
Thanks for taking the time to request this feature! If your feature request is complex or substantial enough to warrant in-depth discussion, maintainers may close the issue and ask you to open a [Discussion](https://github.com/NASA-AMMOS/aerie/discussions).
8
+
Thanks for taking the time to request this feature! If your feature request is complex or substantial enough to warrant in-depth discussion, maintainers may close the issue and ask you to open a [Discussion](https://github.com/NASA-AMMOS/plandev/discussions).
Copy file name to clipboardExpand all lines: deployment/Environment.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -13,7 +13,7 @@ This document provides detailed information about environment variables for each
13
13
14
14
## PlanDev Gateway
15
15
16
-
See the [environment variables document](https://github.com/NASA-AMMOS/aerie-gateway/blob/develop/docs/ENVIRONMENT.md) in the PlanDev Gateway repository.
16
+
See the [environment variables document](https://github.com/NASA-AMMOS/plandev-gateway/blob/develop/docs/ENVIRONMENT.md) in the PlanDev Gateway repository.
17
17
18
18
## PlanDev Merlin
19
19
@@ -105,7 +105,7 @@ See the [environment variables document](https://github.com/NASA-AMMOS/aerie-gat
105
105
106
106
## PlanDev UI
107
107
108
-
See the [environment variables document](https://github.com/NASA-AMMOS/aerie-ui/blob/develop/docs/ENVIRONMENT.md) in the PlanDev UI repository.
108
+
See the [environment variables document](https://github.com/NASA-AMMOS/plandev-ui/blob/develop/docs/ENVIRONMENT.md) in the PlanDev UI repository.
Copy file name to clipboardExpand all lines: deployment/README.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -50,7 +50,7 @@ does not exceed the host's remaining available cores (considering other processe
50
50
51
51
## Starting the Services
52
52
53
-
Download and unzip the latest [Deployment.zip](https://github.com/NASA-AMMOS/aerie/releases) file onto your local machine, then do:
53
+
Download and unzip the latest [Deployment.zip](https://github.com/NASA-AMMOS/plandev/releases) file onto your local machine, then do:
54
54
55
55
```sh
56
56
cd deployment
@@ -72,4 +72,4 @@ docker-compose down
72
72
## Troubleshooting
73
73
74
74
- Make sure you are starting all the Docker containers in a clean environment. This means before starting the services make sure all containers are removed, all images are removed, and all volumes are removed.
75
-
- If you are having trouble and cannot find the answer here, please contact someone from the PlanDev team via the [#mpsa-aerie-users](https://app.slack.com/client/T024LMMEZ/C0163E42UBF) Slack channel.
75
+
- If you are having trouble and cannot find the answer here, please contact someone from the PlanDev team via the [#mpsa-plandev-users](https://app.slack.com/client/T024LMMEZ/C0163E42UBF) Slack channel.
Copy file name to clipboardExpand all lines: docs/CONTRIBUTING.md
+11-11Lines changed: 11 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -51,9 +51,9 @@ The PlanDev project relies on the ability to effectively query the Git history.
51
51
52
52
Please follow these instructions when submitting a Pull Request:
53
53
54
-
1. Search [GitHub](https://github.com/NASA-AMMOS/aerie/pulls) for an open or closed PR that relates to your submission. You don't want to duplicate effort.
54
+
1. Search [GitHub](https://github.com/NASA-AMMOS/plandev/pulls) for an open or closed PR that relates to your submission. You don't want to duplicate effort.
55
55
1. Be sure that an issue describes the problem you're fixing, or documents the design for the feature you'd like to add. Discussing the design up front helps to ensure that we're ready to accept your work.
56
-
1. Clone the [PlanDev repo](https://github.com/NASA-AMMOS/aerie).
56
+
1. Clone the [PlanDev repo](https://github.com/NASA-AMMOS/plandev).
57
57
1. Make your changes in a new git branch:
58
58
59
59
```sh
@@ -77,7 +77,7 @@ Please follow these instructions when submitting a Pull Request:
77
77
git push origin my-fix-branch
78
78
```
79
79
80
-
1. In GitHub, send a pull request to `aerie:develop`.
80
+
1. In GitHub, send a pull request to `plandev:develop`.
81
81
1. If we suggest changes then:
82
82
83
83
- Make the required updates.
@@ -110,27 +110,27 @@ After your pull request is merged, you can safely delete your branch and pull th
110
110
111
111
## <aname="submit-pr"></a> Required Checks on PRs
112
112
113
-
When you submit a PR, we use Github Workflows to automatically run a number of CI-type checks on it, all of which must pass before the PR can be merged. These vary slightly from one repo to another, but mostly consist of unit tests, as well as end-to-end (e2e) tests for the backend and frontend (`aerie` and `aerie-ui`) repos. If your PR adds new tests to our existing test suites, they will automatically be run & validated with your PR.
113
+
When you submit a PR, we use Github Workflows to automatically run a number of CI-type checks on it, all of which must pass before the PR can be merged. These vary slightly from one repo to another, but mostly consist of unit tests, as well as end-to-end (e2e) tests for the backend and frontend (`plandev` and `plandev-ui`) repos. If your PR adds new tests to our existing test suites, they will automatically be run & validated with your PR.
114
114
115
115
You can see the status of these checks at the bottom of the PR on Github - it should say "All checks have passed" if all is well. If it says "Some checks are not successful", you'll need to troubleshoot the cause of the failure before your PR can be accepted. Click "show all checks", then "details" to get detailed server logs from every step of the GH action that failed. Note that some of these runs may also have *files attached* to the run, which contain more detailed logs.
116
116
117
117
If you can't determine the cause of the failure from logs alone, it may be helpful to try and reproduce the problem locally. You can see the commands run by the Required Check actions by looking in each repo under `.github/workflows` - each `yml` file in this folder contains the setup & commands necessary to run the check locally yourself.
118
118
119
119
## <aname="submit-pr"></a> Running E2E Tests with specific branches/images
120
120
121
-
Both `aerie` and `aerie-ui` repos contain **end-to-end (E2E) tests** which depend on code from other PlanDev repos. Specifically:
122
-
- The `aerie` backend e2e test suite, which tests a fully running PlanDev API, depends on `aerie-gateway` since it is part of the API
123
-
- The `aerie-ui` e2e suite, which tests a full PlanDev UI + backend, depends on `aerie` and `aerie-gateway` code since it is a full stack test
121
+
Both `plandev` and `plandev-ui` repos contain **end-to-end (E2E) tests** which depend on code from other PlanDev repos. Specifically:
122
+
- The `plandev` backend e2e test suite, which tests a fully running PlanDev API, depends on `plandev-gateway` since it is part of the API
123
+
- The `plandev-ui` e2e suite, which tests a full PlanDev UI + backend, depends on `plandev` and `plandev-gateway` code since it is a full stack test
124
124
125
125
Sometimes a new feature requires code changes in *multiple repos simultaneously*, eg. a UI PR may add a new UI element that displays a new database field, but relies on a corresponding backend PR to add the new field. In this case, the UI PR's e2e tests will fail unless it has a way to *specify* which backend PR(s)/branches should be used for the e2e test.
126
126
127
127
To handle this situation, follow these steps with your PRs:
128
-
1. When you submit an `aerie` or `aerie-gateway` PR, if your PR contains code that *other PRs depend on*, add the GH label **"publish"** to the PR. This will cause an additional workflow to run which *publishes* the code in that branch to a docker image called eg. `pr-9999` for use by other PRs.
129
-
2. When you submit an `aerie-ui` or `aerie` PR, if it *depends on other PR(s)* (aerie or gateway) for its tests to pass, edit the **body of your PR** to contain one or both of the following lines:
128
+
1. When you submit a `plandev` or `plandev-gateway` PR, if your PR contains code that *other PRs depend on*, add the GH label **"publish"** to the PR. This will cause an additional workflow to run which *publishes* the code in that branch to a docker image called eg. `pr-9999` for use by other PRs.
129
+
2. When you submit an `plandev-ui` or `plandev` PR, if it *depends on other PR(s)* (plandev or gateway) for its tests to pass, edit the **body of your PR** to contain one or both of the following lines:
130
130
```
131
131
___REQUIRES_AERIE_PR___="9999"
132
132
___REQUIRES_GATEWAY_PR___="9999"
133
133
```
134
-
Replace "9999" with the **PR number(s)** of the relevant `aerie`/`gateway` PR(s). PRs to `aerie-ui` allow either/both of these fields, while `aerie` PRs only allow a `gateway` PR to be specified.
134
+
Replace "9999" with the **PR number(s)** of the relevant `plandev`/`gateway` PR(s). PRs to `plandev-ui` allow either/both of these fields, while `plandev` PRs only allow a `gateway` PR to be specified.
135
135
136
-
For example, see [this PR](https://github.com/NASA-AMMOS/aerie-ui/pull/1420) or [this PR](https://github.com/NASA-AMMOS/aerie-ui/pull/1492).
136
+
For example, see [this PR](https://github.com/NASA-AMMOS/plandev-ui/pull/1420) or [this PR](https://github.com/NASA-AMMOS/plandev-ui/pull/1492).
Use the following task to print a report of the dependencies that have updates available.
75
75
76
76
```sh
77
-
cdaerie
77
+
cdplandev
78
78
./gradlew dependencyUpdates
79
79
```
80
80
@@ -83,7 +83,7 @@ cd aerie
83
83
To run the PlanDev services you need to first set the proper environment variables. First copy the template:
84
84
85
85
```sh
86
-
cdaerie
86
+
cdplandev
87
87
cp .env.template .env
88
88
```
89
89
@@ -103,16 +103,16 @@ POSTGRES_USER=postgres
103
103
The [docker-compose.yml](../docker-compose.yml) in the root directory deploys PlanDev locally, creating containers using the artifacts from the build step above.
104
104
105
105
```sh
106
-
cdaerie
106
+
cdplandev
107
107
docker-compose up --build --detach
108
108
```
109
109
110
-
Once PlanDev is started you can visit [http://localhost](http://localhost) to view the [PlanDev UI](https://github.com/NASA-AMMOS/aerie-ui). You can visit [http://localhost:8080](http://localhost:8080) to view the [Hasura Console](https://hasura.io/).
110
+
Once PlanDev is started you can visit [http://localhost](http://localhost) to view the [PlanDev UI](https://github.com/NASA-AMMOS/plandev-ui). You can visit [http://localhost:8080](http://localhost:8080) to view the [Hasura Console](https://hasura.io/).
Copy file name to clipboardExpand all lines: docs/GOVERNANCE.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,7 +12,7 @@ Anyone who has downloaded, deployed, or operated the PlanDev system to meet a sp
12
12
13
13
### Contributor
14
14
15
-
Contributors include anyone that provides input to the project. This includes code, issues, documentation, graphics, designs, or anything else that tangibly improves the project. We encourage you to start contributing right away by joining our [Discussions](https://github.com/NASA-AMMOS/aerie/discussions) or submitting an [Issue](https://github.com/NASA-AMMOS/aerie/issues).
15
+
Contributors include anyone that provides input to the project. This includes code, issues, documentation, graphics, designs, or anything else that tangibly improves the project. We encourage you to start contributing right away by joining our [Discussions](https://github.com/NASA-AMMOS/plandev/discussions) or submitting an [Issue](https://github.com/NASA-AMMOS/plandev/issues).
16
16
17
17
### Triager
18
18
@@ -61,8 +61,8 @@ A subset of the collaborators forms the Technical Steering Committee (TSC). The
61
61
62
62
The TSC is primarily responsible for the PlanDev core and UI projects:
63
63
64
-
-https://github.com/NASA-AMMOS/aerie
65
-
-https://github.com/NASA-AMMOS/aerie-ui
64
+
-https://github.com/NASA-AMMOS/plandev
65
+
-https://github.com/NASA-AMMOS/plandev-ui
66
66
67
67
However, the TSC also has responsibility over some projects, which are dependencies of the core projects:
0 commit comments