Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
JunTaoLuo committed Dec 15, 2023
1 parent 1ad335d commit 6dcc277
Show file tree
Hide file tree
Showing 4 changed files with 30 additions and 17 deletions.
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -138,6 +138,7 @@ This section outlines only the systems utilized by the CMS. See the READMEs in t
- A single "mirror" environment is regularly populated with a sanitized production database copy.
- Open Pull Requests get environments created automatically, cloned from the "mirror" environment, with URLs like:
- [pr123-{hash}.ci.cms.va.gov](https://pr123-{hash}.ci.cms.va.gov) for the CMS
- Cypress test logs and artifacts, navigate to https://pr123-{hash}.ci.cms.va.gov/cypress/
- [web-{hash}.ci.cms.va.gov](http://web-{hash}.ci.cms.va.gov) for the frontend web build
- [storybook-{hash}.ci.cms.va.gov](http://storybook-{hash}.ci.cms.va.gov) for design system documentation
- Ad-hoc environments can be created and deleted at any time by any logged in user on [tugboat.vfs.va.gov/](https://tugboat.vfs.va.gov/):
Expand Down
22 changes: 14 additions & 8 deletions READMES/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,15 +75,21 @@ See [the Codespaces README](./codespaces.md) to get a fully functional cloud-bas
## Step 2: Launch development environment
1. [Install ddev](https://ddev.readthedocs.io/en/stable/#installation)
2. Change into the project directory and run `ddev start`:
1. Set ddev environment variables:
```bash
$ cd va.gov-cms
$ ddev start
```
```bash
$ cd va.gov-cms
$ cp .env.example .env
```
2. [Install ddev](https://ddev.readthedocs.io/en/stable/#installation)
3. Change into the project directory and run `ddev start`:
```bash
$ ddev start
```
The `ddev start` command will include the `composer install` command.
The `ddev start` command will include the `composer install` command. Ensure that a CMS account is created and [Step 3](#step-3-sync-your-local-site-with-production-data) is run to sync login information before logging into the local CMS environment.
See [Environments: Local](./local.md) for more information on ddev.
Expand All @@ -96,7 +102,7 @@ correct locations in your local development environment.
- `ddev pull va ` or `ddev pull va --skip-files`
NOTE: This command downloads and impoorts the db followed by any configuration import.
NOTE: This command downloads and imports the db followed by any configuration import.
If you are not using ddev, the scripts will
fail, but the files will still be available. The `sync-db.sh` script downloads the
Expand Down
24 changes: 15 additions & 9 deletions READMES/https.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,15 +14,21 @@ If you see a message from your browser like the following:

Click the "^" button and select "Keep."

### OSX
1. Open Keychain Access
1. Go to Certificates (under Category in left sidebar)
2. Select "System" under Keychains (in sidebar)
3. Select "Import Items..." from File menu. (Shift-Command-I)
4. Select the three .cer files above.
5. They should now appear in your list of certificates
6. For each certificate: 1) File > Get info 2) Under Trust > When using this certificate, select "Always Trust". 3) Close the Get info window, which will prompt a password save.
7. You may need to restart your browser.
### macOS (as of 13.4)
1. Import the certificates.
1. Open Keychain Access
1. Select "System" under System Keychains (in sidebar)
<img src="images/macos-keychains.png" height="200">
1. Select "Import Items..." from File menu. (Shift-Command-I)
1. Select the three .cer files above.
1. They should now appear in your list of certificates under the "Keychain Access" view
1. Trust each certificate.
1. For each of the three certificates, select it
1. File > Get info (Command-I)
1. Expand the "Trust" view
1. In the "When using this certificate" popup button, select "Always Trust".
1. Close the "Get Info" window, which will prompt a password save.
1. You may need to restart your browser.

### Linux

Expand Down
Binary file added READMES/images/macos-keychains.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 6dcc277

Please sign in to comment.