docs: Update frontend dev docs (#2666)
Resolves https://github.com/webrecorder/browsertrix/issues/2633 ## Changes - Replaces broken link in frontend README with hosted and local links - Clarifies that frontend is not deployed separately in dev docs
This commit is contained in:
parent
1a6d2a20c2
commit
826d70b649
@ -1 +1,19 @@
|
|||||||
[Development guide](../docs/develop/frontend-dev.md)
|
# Browsertrix Frontend
|
||||||
|
|
||||||
|
This directory contains the following components:
|
||||||
|
|
||||||
|
## Docs (`/docs`)
|
||||||
|
|
||||||
|
Documentation for running, developing, and writing docs:
|
||||||
|
- Hosted: [docs.browsertrix.com/develop/docs](https://docs.browsertrix.com/develop/docs)
|
||||||
|
- Local: [develop/docs.md](./docs/docs/develop/docs.md)
|
||||||
|
|
||||||
|
## User Interface (`/src`)
|
||||||
|
|
||||||
|
Documentation for developing the user interface:
|
||||||
|
- Hosted: [docs.browsertrix.com/develop/frontend-dev](https://docs.browsertrix.com/develop/frontend-dev)
|
||||||
|
- Local: [develop/frontend-dev.md](./docs/docs/develop/frontend-dev.md)
|
||||||
|
|
||||||
|
## Configuration
|
||||||
|
|
||||||
|
Config files for the frontend Docker build and nginx routing can also be found in this directory.
|
||||||
|
@ -130,6 +130,5 @@ After making any changes to backend code (in `./backend`) or frontend code (in `
|
|||||||
|
|
||||||
Changes to settings in `./chart/local.yaml` can be deployed with `helm upgrade ...` directly.
|
Changes to settings in `./chart/local.yaml` can be deployed with `helm upgrade ...` directly.
|
||||||
|
|
||||||
## Deploying Frontend Only
|
??? Info "Alternative method for developing the frontend"
|
||||||
|
If you are not writing backend code or otherwise making changes to the backend, you can run the frontend outside of Docker to quickly iterate on the user interface. See [UI Development](./frontend-dev.md) for instructions on how to develop the frontend using Node.js tools.
|
||||||
If you are just making changes to the frontend, you can also [deploy the frontend separately](frontend-dev.md) using a dev server for quicker iteration.
|
|
||||||
|
Loading…
Reference in New Issue
Block a user