Skip to content

Commit

Permalink
Fix minor issues in docs
Browse files Browse the repository at this point in the history
  • Loading branch information
JulioV committed Jan 26, 2021
1 parent 25a3492 commit eb258d8
Show file tree
Hide file tree
Showing 3 changed files with 23 additions and 22 deletions.
40 changes: 20 additions & 20 deletions docs/developers/git-flow.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,29 +23,29 @@ git commit -m "Add my new feature" # use a concise description
```
1. Integrate your new feature to `develop`

=== "Internal Developer"
You are an internal developer if you have writing permissions to the repository.

Most feature branches are never pushed to the repo, only do so if you expect that its development will take days (to avoid losing your work if you computer is damaged). Otherwise follow the following instructions to locally rebase your feature branch into `develop` and push those rebased changes online.
=== "Internal Developer"
You are an internal developer if you have writing permissions to the repository.
Most feature branches are never pushed to the repo, only do so if you expect that its development will take days (to avoid losing your work if you computer is damaged). Otherwise follow the following instructions to locally rebase your feature branch into `develop` and push those rebased changes online.

```bash
git checkout feature/feature1
git fetch origin develop
git rebase -i develop
git checkout develop
git merge --no-ff feature/feature1 # (use the default merge message)
git push origin develop
git branch -d feature/feature1
```
```bash
git checkout feature/feature1
git fetch origin develop
git rebase -i develop
git checkout develop
git merge --no-ff feature/feature1 # (use the default merge message)
git push origin develop
git branch -d feature/feature1
```

=== "External Developer"
You are an external developer if you do NOT have writing permissions to the repository.
=== "External Developer"
You are an external developer if you do NOT have writing permissions to the repository.

Push your feature branch online
```bash
git push --set-upstream origin feature/external-test
```
Then open a pull request to the `develop` branch using Github's GUI
Push your feature branch online
```bash
git push --set-upstream origin feature/external-test
```
Then open a pull request to the `develop` branch using Github's GUI

## Release a New Version

Expand Down
3 changes: 2 additions & 1 deletion docs/features/phone-screen.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,9 +47,10 @@ Features description for `[PHONE_SCREEN][PROVIDERS][RAPIDS]`:
|avgduration |minutes |Average duration of all unlock episodes.
|stdduration |minutes |Standard deviation duration of all unlock episodes.
|countepisode |episodes |Number of all unlock episodes
<!-- |episodepersensedminutes |episodes/minute |The ratio between the total number of episodes in an epoch divided by the total time (minutes) the phone was sensing data. -->
|firstuseafter |minutes |Minutes until the first unlock episode.

<!-- |episodepersensedminutes |episodes/minute |The ratio between the total number of episodes in an epoch divided by the total time (minutes) the phone was sensing data. -->

!!! note "Assumptions/Observations"
1. In Android, `lock` events can happen right after an `off` event, after a few seconds of an `off` event, or never happen depending on the phone\'s settings, therefore, an `unlock` episode is defined as the time between an `unlock` and a `off` event. In iOS, `on` and `off` events do not exist, so an `unlock` episode is defined as the time between an `unlock` and a `lock` event.

Expand Down
2 changes: 1 addition & 1 deletion docs/setup/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ When you are done with this configuration, go to [executing RAPIDS](../execution
MY_GROUP
```
!!! hint
If you are using RAPIDS' docker container and Docker-for-mac or Docker-for-Windows 18.03+, you can connect to a MySQL database in your host machine using the `host.docker.internal` instead of `127.0.0.1` or `localhost`
If you are using RAPIDS' docker container and Docker-for-mac or Docker-for-Windows 18.03+, you can connect to a MySQL database in your host machine using `host.docker.internal` instead of `127.0.0.1` or `localhost`. In a Linux host you need to run our docker container using `docker run --network="host" -d moshiresearch/rapids:latest` and then `127.0.0.1` will point to your host machine.
!!! note
- You can ignore this step if you are only processing Fitbit data in CSV files.
- RAPIDS only supports MySQL/MariaDB databases. If you would like to add support for a different database engine get in touch and we can discuss how to implement it.
Expand Down

0 comments on commit eb258d8

Please sign in to comment.