[Issue #3474] Doc updates for auth #3491
Conversation
acouch
requested review from
andycochran,
btabaska,
doug-s-nava,
chouinar,
coilysiren,
mdragon and
widal001
as code owners
acouch
force-pushed
the
acouch/issue-3474-dev-doc-auth-updates
branch
from
7ec7e79 to
84828d9
Compare
This comment was marked as resolved.
This comment was marked as resolved.
|
|
||
| ## OpenSearch setup | ||
| Run `make init && make run logs` to start the local containers. The application will be available at `http://localhost:8080/docs`. |
There was a problem hiding this comment.
Seems like directing to the docs site is a little confusing here. Would just saying "http://localhost:8080" make more sense?
| * Postgres database | ||
| * OpenSearch node | ||
| * OpenSearchdashboard (http://localhost:5601) | ||
| * localstack |
There was a problem hiding this comment.
would be nice to have a brief note on what localstack is used for in this context. I had to look it up but seems like s3?
|
|
||
| * **Localstack (local s3)** | ||
| * Run `make init-localstack` | ||
| * **Mock OAuth server** |
There was a problem hiding this comment.
this doesn't seem to be mentioned in any other documentation. Is it worth mentioning in this file what this is for and how / when to use it, maybe in the "User Authentication" section?
| 1. Download the VS Code extension described in these [Playwright docs](https://playwright.dev/docs/running-tests#run-tests-in-vs-code) | ||
| 2. Follow the [instructions](https://playwright.dev/docs/getting-started-vscode#running-tests) Playwright provides | ||
|
|
||
| Playwright E2E tests run "local-to-local", requiring both the frontend and the API to be running for the tests to pass - and for the database to be seeded with data. |
There was a problem hiding this comment.
I've been confused by this - I actually get an error if I try to run e2e tests locally in VS code while running a dev server. If I have a built application in the .next directory, though, it seems to work without starting an actual server, and seems to start its own automatically
Co-authored-by: doug-s-nava <92806979+doug-s-nava@users.noreply.github.com>
Co-authored-by: doug-s-nava <92806979+doug-s-nava@users.noreply.github.com>
Co-authored-by: doug-s-nava <92806979+doug-s-nava@users.noreply.github.com>
Co-authored-by: doug-s-nava <92806979+doug-s-nava@users.noreply.github.com>
Co-authored-by: doug-s-nava <92806979+doug-s-nava@users.noreply.github.com>
Co-authored-by: doug-s-nava <92806979+doug-s-nava@users.noreply.github.com>
Summary
Fixes #3474
Time to review: 10 mins
Changes proposed
documentation/api/development.md
This doesn't remove anything, moves some of the local setup initially at the top under the
## Local (non-Docker)section, adds some of the recent commands added including local stack and the oauth mock, and user auth setupfrontend/README.md
Removes detail on docker and other setup for the frontend development doc.
documentation/frontend/development.md
Reorganizes and consolidates frontend dev setup and aligns some of the headers with the API development doc.