Skip to content

Commit

Permalink
Documentation updates (#2257)
Browse files Browse the repository at this point in the history
## Summary
Fixes a broken link in /documentation/api/database-local-usage.md

### Time to review: __5 mins__

Sorry, this and #2256 should've been a single PR.
  • Loading branch information
mxk0 authored Sep 30, 2024
1 parent e78f9b2 commit b1aba81
Show file tree
Hide file tree
Showing 3 changed files with 27 additions and 31 deletions.
44 changes: 20 additions & 24 deletions MAINTAINERS.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,24 @@

This is a list of maintainers for this project. See [CODEOWNERS](/.github/CODEOWNERS) for list of reviewers for different parts of the codebase. Team members include:

<!-- Note: team members listed in alphabetical order by last name -->

## Engineering

* Aaron Couch
* Brandon Tabaska
* Doug Schrashun
* Kai Siren
* Matt Dragon
* Michael Chouinard

## Content and Design

* Andy Cochran
* Crystabel Rangel
* Emily Ianacone
* Jenn Snyder
* Risha Lee
* Senongo Akpem

## Product and Delivery

Expand All @@ -12,31 +28,11 @@ This is a list of maintainers for this project. See [CODEOWNERS](/.github/CODEOW
* Sarah Knopp
* Billy Daly
* Eric Valenzuela
* David Dudas

## Engineering

* Aaron Couch
* Alsia Plybeah
* Kai Siren
* Michael Chouinard
* Sammy Steiner
* Brett Rosenblatt
* Brandon Tabaska
* Ebuwa Evbuoma-Fike
* James Bursa
* Ryan Lewis

## Product and Project Management
## Product and Program Management

* Sumi Thaiveettil
* Margaret Spring
* Max Kramer


## Content and Design

* Andy Cochran
* Emily Ianacone
* Risha Lee
* Crystabel Rangel
* Senongo Akpem
* Meghan Casey
2 changes: 1 addition & 1 deletion documentation/api/database/database-local-usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Steps:

![Local DB Connection Parameters](../images/local-db-connection.png)

Connection parameters for the database can be found in [local.env](../../api/local.env) including the password.
Connection parameters for the database can be found in [local.env](../../../api/local.env) including the password.

### CLI

Expand Down
12 changes: 6 additions & 6 deletions documentation/api/development.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,6 @@ A very simple [docker-compose.yml](../../docker-compose.yml) has been included t

## Prerequisites

**Note:** Run everything from within the `/api` folder:

1. Install the version of Python specified in [pyproject.toml](../../api/pyproject.toml)
[pyenv](https://github.com/pyenv/pyenv#installation) is one popular option for installing Python,
or [asdf](https://asdf-vm.com/).
Expand All @@ -23,6 +21,8 @@ A very simple [docker-compose.yml](../../docker-compose.yml) has been included t

4. You'll also need [Docker Desktop](https://www.docker.com/products/docker-desktop/)

## **Note:** All the following commands should be run from the `/api` directory.

## Database setup: Run Migrations/Seeds

1. If you haven't done local development before you'll need to execute the migrations and seed the DB with data using the steps in [database-local-usage.md](database/database-local-usage.md)
Expand All @@ -37,11 +37,11 @@ If your DB or OpenSearch end up in an odd place, you can reset all the persisten
## Run the application

1. Make sure you have [Docker Desktop](https://www.docker.com/products/docker-desktop/) installed & running.
2. Run `make -C api setup-local` to install dependencies
3. Run `make -C api init start` to build the image and start the container.
2. Run `make setup-local` to install dependencies
3. Run `make init start` to build the image and start the container.
4. Navigate to `localhost:8080/docs` to access the Swagger UI.
5. Run `make -C api run-logs` to see the logs of the running API container
6. Run `make -C api stop` when you are done to delete the container.
5. Run `make run-logs` to see the logs of the running API container
6. Run `make stop` when you are done to delete the container.

## Some Useful Commands

Expand Down

0 comments on commit b1aba81

Please sign in to comment.