Skip to content

Commit ff8978e

Browse files
authored
Update README.md
1 parent b3d12a0 commit ff8978e

File tree

1 file changed

+16
-11
lines changed

1 file changed

+16
-11
lines changed

README.md

Lines changed: 16 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,17 @@
1-
# Contents of This Repo
1+
# Dev Standards
22

3-
## Branch Strategy
3+
### Branch Strategy
44

55
* **main**: day to day work goes here.
66
* **dev**: current code of the dev environment. No commits allowed directly; you'll need to open a PR from main. Committing/pushing here causes a deployment to the dev infrastructure.
77

8-
## Frontend Tier
8+
### GH Actions
9+
10+
See GitHub's actions tab in this repo for more deployment examples/steps.
11+
12+
# System Overview
13+
14+
### Frontend Tier
915
* ```frontend```: The Workspaces frontend (VueJS app).
1016
* Code here: https://github.com/TaskarCenterAtUW/workspaces-frontend.
1117
* Uses the other components within this repo, e.g. ```osm-rails```, ```osm-cgimap``` and ```tasking-manager``` as an API backend.
@@ -15,14 +21,16 @@
1521
* Workspaces version in the ```workspaces``` branch. Need to pull from public version periodically to keep up to date.
1622
* Public version: tries to be a match to ```main``` of upstream.
1723

18-
## Backend Tier
24+
### Backend Tier
1925
* ```osm-web```: Reverse proxy that dispatches requests to osm-cgimap or osm-rails depending on performance requirements.
2026
* ```osm-log-proxy```: sits in front of the below two services, logs requests for debugging purposes.
2127
* ```osm-rails```: “reference implementation” for OSM API for editing. Slow.
2228
* ```osm-cgimap```: Faster version of osm-rails. API format the same as osm-rails. Only some functions of osm-rails.
2329
* ```tasking-manager```: Not currently using, but task manager for OSM.
24-
25-
# To build images
30+
31+
# Getting Started
32+
33+
### To build images
2634

2735
```git clone --recursive https://github.com/TaskarCenterAtUW/workspaces-stack.git```
2836

@@ -32,17 +40,14 @@
3240

3341
Replace XXX.env with the environment definition file of the environment for which you want to build an image. This can be overridden when running (see below).
3442

35-
# To update docker daemon to run with latest images
43+
### To update docker daemon to run with latest images
3644

3745
```docker-compose -f docker-compose.deploy.yml --env-file XXX.env up -d -pull always --force-recreate --remove-orphans```
3846

3947
Replace XXX.env with the environment definition file of the environment for which you are deploying.
4048

41-
# Other Files
49+
### Other Files
4250

4351
* ```example.env```: template of the .env file required by the Docker compose YAML files
4452
* ```tdei_uw.env```: .env for deployment at UW's TDEI center. Only UW should use this, new users should adapt example.env to suit their needs. LTG: remove this file from this repo.
4553

46-
# GH Actions
47-
48-
See GitHub's actions tab in this repo for more deployment examples/steps.

0 commit comments

Comments
 (0)