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 9cbe310 commit dd877c7
Show file tree
Hide file tree
Showing 5 changed files with 10 additions and 3 deletions.
7 changes: 5 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# VA.gov CMS

This is the public/open documentation for the VA.gov Content Management System (CMS). The private/sensitive documentation is [here](https://github.com/department-of-veterans-affairs/va.gov-team-sensitive/tree/master/platform/cms). See [sensitive-guidance.md](https://github.com/department-of-veterans-affairs/va.gov-team/blob/master/platform/working-with-vsp/policies-work-norms/sensitive-guidance.md) to read about what should be public vs. private. We follow the U.S. Digital Services Playbook and [default to open/public](https://playbook.cio.gov/#play13)).
This is the public/open documentation for the VA.gov Content Management System (CMS) for development, QA and DevOps topics. For product, design, research and cross-team documentation, visit the [platform/cms docs](https://github.com/department-of-veterans-affairs/va.gov-team/tree/master/platform/cms). For private/sensitive documentation, visit the [private docs repo](https://github.com/department-of-veterans-affairs/va.gov-team-sensitive/tree/master/platform/cms). See [sensitive-guidance.md](https://github.com/department-of-veterans-affairs/va.gov-team/blob/master/platform/working-with-vsp/policies-work-norms/sensitive-guidance.md) to read about what should be public vs. private. We follow the U.S. Digital Services Playbook and [default to open/public](https://playbook.cio.gov/#play13)).

[VA.gov](https://www.va.gov) is constructed at the highest level by three projects:
- the **CMS** or **Content Management System**, in this repository
Expand Down Expand Up @@ -47,7 +47,9 @@ The VA.gov CMS Team
1. [Testing](READMES/testing.md)
1. [Debugging](READMES/debugging.md)
1. [Comparing GraphQL Output](READMES/comparing-graphql-output.md)
1. [Dependabot Alerts](READMES/dependabot-alerts.md)
1. [Dependabot Updates](READMES/dependabot-updates.md)
1. [Sentry](READMES/sentry.md)
1. [Profiling with Blackfire](READMES/blackfire.md)
1. [Scalability Testing](READMES/scalability-testing.md)
1. **Release & Deployment**
Expand All @@ -65,6 +67,7 @@ The VA.gov CMS Team
1. Migrations (data imports)
1. [Facility](READMES/migrations-facility.md)
1. [Form](READMES/migrations-forms.md)
1. [Removing deprecated fields](READMES/remove-deprecated-fields.md)
1. [Security](READMES/security.md)
1. [Upstream Dependencies](READMES/upstream-dependencies.md)
1. [Downstream Dependencies](READMES/downstream_dependencies.md)
Expand Down Expand Up @@ -141,7 +144,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/
- Cypress test logs and artifacts, see [Testing](READMES/testing.md) for details.
- [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
File renamed without changes.
File renamed without changes.
2 changes: 1 addition & 1 deletion READMES/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ See [the Codespaces README](./codespaces.md) to get a fully functional cloud-bas
```sh
$ git fetch --all
```
q
* Make sure git is not tracking perms
```sh
$ git config core.fileMode false
Expand Down
4 changes: 4 additions & 0 deletions READMES/interfaces.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,10 @@ and common calls look like:

* Since this is a React widget displaying dynamic data it’s not using Metalsmith templates. The .jsx component files to support rendering are located in https://github.com/department-of-veterans-affairs/vets-website/tree/main/src/applications/facility-locator/components

## JSON API

See [JSON:API](jsonapi.md)

## Mirrors

There are environments which exist in [Tugboat](tugboat.md) that provide a mirror of Prod. The content and code are updated daily at 3am EST on the mirrors. The list of mirrors can be found in the "[Mirrors (refreshed daily from PROD at 3am ET)](https://tugboat.vfs.va.gov/6042eeed6a89945a99399d3d)" project in tugboat. Contact CMS Support in the #cms-support Slack channel to request a new mirror.
Expand Down

0 comments on commit dd877c7

Please sign in to comment.