Skip to content

Commit

Permalink
docs: update readme's
Browse files Browse the repository at this point in the history
  • Loading branch information
steveoh committed Jun 28, 2023
1 parent 334fc7e commit e1f7bb9
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 4 deletions.
6 changes: 2 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,11 @@ A porter is person that
- carries things, such as bags
- performs routine cleaning, likely on a train, taking care of the sleeping berths.

AGRC tracks the additions, replacements, and deletions of SGID items (in the broadest sense of add, replace, or delete) through issues in this repository.
UGRC tracks the additions, replacements, and deletions of SGID items (in the broadest sense of add, replace, or delete) through issues in this repository.

## How to use

1. [Create a new issue](https://github.com/agrc/cemetery/issues/new/choose) when an application, dataset, or both needs to be added, deleted, or moved to a different long-term storage
1. [Create a new issue](https://github.com/agrc/porter/issues/new/choose) when an application, dataset, or both needs to be added, deleted, or moved to a different long-term storage
1. Choose the `Removing Data From Anywhere` (for moving or deleting data) or `Introduce data to the SGID` (for adding data) template from the buttons
1. Tag the three triagers (one from each team) in the triage section:
- [ ] Data Team Triage (@gregbunce)
Expand All @@ -25,8 +25,6 @@ AGRC tracks the additions, replacements, and deletions of SGID items (in the bro

## Data Flow for New SGID Datasets

Data in the internal SGID will automatically be added to the SGID10 with via the swapper pallet.

If there is a record added to `SGID.META.AGOLItems`, the corresponding dataset will automatically be added to:

1. the open sgid with cloudb
Expand Down
3 changes: 3 additions & 0 deletions src/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -108,6 +108,9 @@ docker push gcr.io/ut-dts-agrc-porter-prod/conductor

## Development

1. create new python environment: `python -m venv venv`
1. activate new environment: `source venv/bin/activate` (On Windows: `.env\Scripts\activate`)
1. install dependencies and editable project: `pip install -e ".[tests]"`
1. use `test_conductor` as the entry point
1. install the Microsoft ODBC driver for SQL Server for [Windows](https://docs.microsoft.com/en-us/sql/connect/odbc/download-odbc-driver-for-sql-server) or [macOS](https://docs.microsoft.com/en-us/sql/connect/odbc/linux-mac/install-microsoft-odbc-driver-sql-server-macos)
1. create a copy of `src/conductor/connections_sample.py` as `src/conductor/connections.py`
Expand Down

0 comments on commit e1f7bb9

Please sign in to comment.