Docs: Use local fs (#334)
This commit is contained in:
@@ -14,7 +14,7 @@ cd dataline
|
||||
|
||||
This will build all the code and run all the unit tests.
|
||||
|
||||
`./gradle build` creates all the necessary artifacts \(Webapp, Jars and Docker images\) so that you can run dataline locally.
|
||||
`./gradle build` creates all the necessary artifacts \(Webapp, Jars and Docker images\) so that you can run Dataline locally.
|
||||
|
||||
## Run with `docker-compose`
|
||||
|
||||
@@ -25,6 +25,13 @@ VERSION=dev docker-compose up
|
||||
|
||||
The build will take a few minutes. Once it completes, Dataline compiled at current git revision will be running in your environment.
|
||||
|
||||
Dataline by default uses docker volumes for persisting data. If you'd like all persistence to use your local filesystem do the following instead. By default all data will be persisted to `/tmp/dev_root` .
|
||||
|
||||
```bash
|
||||
./gradlew build
|
||||
docker-compose --env-file .env.dev -f docker-compose.yaml -f docker-compose.dev.yaml up
|
||||
```
|
||||
|
||||
## Run Acceptance Tests
|
||||
|
||||
To run acceptance \(end-to-end\) tests you must have the Dataline running locally.
|
||||
|
||||
@@ -30,7 +30,7 @@ To update with GitBook, follow these instructions:
|
||||
|
||||
1. Create a [new variant](https://docs.gitbook.com/editing-content/variants#create-a-variant). This will create a new branch on [GitHub](https://github.com/datalineio/dataline) with the same name
|
||||
2. Modify the documentation in that new variant
|
||||
3. Save & merge regularly
|
||||
3. Save & merge regularly. Each time you merge, your changes will propagated to your branch. It can take a couple minutes for the changes to show up in [GitHub](https://github.com/datalineio/dataline).
|
||||
4. Once you're satisfied, go on [GitHub](https://github.com/datalineio/dataline) and create a PR for your variant branch
|
||||
5. After the PR is approved, your changes will be merged to `master`
|
||||
6. Don't forget to remove the branch and the variant once your change has been merged
|
||||
|
||||
Reference in New Issue
Block a user