Add documentation and refactor custom filtering

This commit is contained in:
matthewswspence 2024-08-27 14:58:04 -05:00
parent 7dafc863c0
commit f6e10b6585
No known key found for this signature in database
GPG key ID: FB458202A7852BA4
12 changed files with 61 additions and 33 deletions

View file

@ -816,3 +816,30 @@ Example: `cf ssh getgov-za`
| | Parameter | Description |
|:-:|:-------------------------- |:-----------------------------------------------------------------------------------|
| 1 | **federal_cio_csv_path** | Specifies where the federal CIO csv is |
## Update First Ready Values
This section outlines how to run the populate_first_ready script
### Running on sandboxes
#### Step 1: Login to CloudFoundry
```cf login -a api.fr.cloud.gov --sso```
#### Step 2: SSH into your environment
```cf ssh getgov-{space}```
Example: `cf ssh getgov-za`
#### Step 3: Create a shell instance
```/tmp/lifecycle/shell```
#### Step 4: Running the script
```./manage.py update_first_ready --debug```
### Running locally
```docker-compose exec app ./manage.py update_first_ready --debug```
##### Optional parameters
| | Parameter | Description |
|:-:|:-------------------------- |:----------------------------------------------------------------------------|
| 1 | **debug** | Increases logging detail. Defaults to False. |