reorder docs

This commit is contained in:
timothycarambat 2023-06-16 17:26:42 -07:00
parent c4eb46ca19
commit 81b2159329

View File

@ -34,6 +34,12 @@ As files are processed you will see data being written to both the `collector/ou
If collection fails at any point in the process it will pick up where it last bailed out so you are not reusing credits.
### Running the document processing API locally
From the `collector` directory with the `v-env` active run `flask run --host '0.0.0.0' --port 8888`.
Now uploads from the frontend will be processed as if you ran the `watch.py` script manually.
**Docker**: If you run this application via docker the API is already started for you and no additional action is needed.
### How to get a Google Cloud API Key (YouTube data collection only)
**required to fetch YouTube transcripts and data**
- Have a google account
@ -43,9 +49,3 @@ If collection fails at any point in the process it will pick up where it last ba
- [Enable YouTube Data APIV3](https://console.cloud.google.com/apis/library/youtube.googleapis.com)
- Once enabled generate a Credential key for this API
- Paste your key after `GOOGLE_APIS_KEY=` in your `collector/.env` file.
### Running the document processing API locally
From the `collector` directory with the `v-env` active run `flask run --host '0.0.0.0' --port 8888`.
Now uploads from the frontend will be processed as if you ran the `watch.py` script manually.
**Docker**: If you run this application via docker the API is already started for you and no additional action is needed.