Skip to content

Commit 23f87f7

Browse files
committed
Add administrative docs
- Add deployment and new year docs links to the readme - Add new year guide
1 parent 4190e06 commit 23f87f7

File tree

2 files changed

+29
-0
lines changed

2 files changed

+29
-0
lines changed

README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,3 +38,10 @@ To run pylint use this command:
3838
```bash
3939
pylint --load-plugins pylint_quotes selections
4040
```
41+
42+
## Administration
43+
### Preparing selections for a new year
44+
Please see the [new year guide](./docs/new_year_guide.md).
45+
46+
### Deploying selections
47+
Deployment resources and documentation are in the [deploy directory](./deploy).

docs/new_year_guide.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# Preparing selections for a new year
2+
There are a couple steps required to get selections ready for a new selections committee.
3+
To do this, you'll either need to be an RTP, or:
4+
- have access to the selections okd project; and
5+
- have write access to mysql in the selections folder; and
6+
- be evals
7+
8+
## Bring down selections
9+
Go into OKD and set the replicas on the prod deployment to 0. This will ensure selections doesn't do anything weird while you're setting up the db.
10+
11+
## Back up and prep Mysql
12+
The following steps will create an archive of the current selections db, and prep the db for a new year
13+
1. Rename `selections_skyler` to `selections_<last year>`
14+
2. Copy the structure of the table back to `selections_skyler`
15+
3. (optional) Reset the auto increments to 1
16+
4. Copy the criteria
17+
18+
## Bring selections back up
19+
Go back and edit the deployment and restore the number of replicas
20+
21+
## Setup teams
22+
Head to selections and start creating teams

0 commit comments

Comments
 (0)