junos
/
rapids
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Fix minor issues in docs

pull/112/head
JulioV 2021-01-26 13:27:53 -05:00
parent 25a3492eba
commit eb258d874a
3 changed files with 23 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

40
docs/developers/git-flow.md
View File

@ -23,29 +23,29 @@ git commit -m "Add my new feature" # use a concise description
``` ```
1. Integrate your new feature to `develop` 1. Integrate your new feature to `develop`
=== "Internal Developer" === "Internal Developer"
You are an internal developer if you have writing permissions to the repository. 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. 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 ```bash
git checkout feature/feature1 git checkout feature/feature1
git fetch origin develop git fetch origin develop
git rebase -i develop git rebase -i develop
git checkout develop git checkout develop
git merge --no-ff feature/feature1 # (use the default merge message) git merge --no-ff feature/feature1 # (use the default merge message)
git push origin develop git push origin develop
git branch -d feature/feature1 git branch -d feature/feature1
``` ```
=== "External Developer" === "External Developer"
You are an external developer if you do NOT have writing permissions to the repository. You are an external developer if you do NOT have writing permissions to the repository.
Push your feature branch online Push your feature branch online
```bash ```bash
git push --set-upstream origin feature/external-test git push --set-upstream origin feature/external-test
``` ```
Then open a pull request to the `develop` branch using Github's GUI Then open a pull request to the `develop` branch using Github's GUI
## Release a New Version ## Release a New Version

3
docs/features/phone-screen.md
View File

@ -47,9 +47,10 @@ Features description for `[PHONE_SCREEN][PROVIDERS][RAPIDS]`:
|avgduration |minutes |Average duration of all unlock episodes. |avgduration |minutes |Average duration of all unlock episodes.
|stdduration |minutes |Standard deviation duration of all unlock episodes. |stdduration |minutes |Standard deviation duration of all unlock episodes.
|countepisode |episodes |Number 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. |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" !!! 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. 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.

2
docs/setup/configuration.md
View File

@ -37,7 +37,7 @@ When you are done with this configuration, go to [executing RAPIDS](../execution
MY_GROUP MY_GROUP
``` ```
!!! hint !!! 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 !!! note
- You can ignore this step if you are only processing Fitbit data in CSV files. - 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. - 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.