Skip to content

Commit

Permalink
Add links to some orphan docs
Browse files Browse the repository at this point in the history
  • Loading branch information
JunTaoLuo committed Dec 15, 2023
1 parent 020c297 commit 9cbe310
Show file tree
Hide file tree
Showing 8 changed files with 20 additions and 8 deletions.
7 changes: 5 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ The VA.gov CMS Team
1. [WEB & CMS Integration](READMES/unity.md)
1. [Workflow](READMES/workflow.md)
1. [Project Conventions](READMES/project-conventions.md)
1. [Code Ownership](READMES/codeowners.md)
1. [Environments](READMES/environments.md)
1. [CI Environments](READMES/tugboat.md)
1. [Local - DDEV](READMES/local.md)
Expand All @@ -45,19 +46,21 @@ The VA.gov CMS Team
1. [Code Review](READMES/code-review.md)
1. [Testing](READMES/testing.md)
1. [Debugging](READMES/debugging.md)
1. [Comparing GraphQL Output](READMES/graph_ql.md)
1. [Comparing GraphQL Output](READMES/comparing-graphql-output.md)
1. [Dependabot Updates](READMES/dependabot-updates.md)
1. [Profiling with Blackfire](READMES/blackfire.md)
1. [Scalability Testing](READMES/scalability-testing.md)
1. **Release & Deployment**
1. [The BRD System: Build, Release, Deploy](READMES/brd.md)
1. [CMS Release Process](READMES/brd.md#cms-release-process)
1. [CMS-CI Release Process (TODO)](READMES/brd.md#cmsci-release-process)
1. **Architecture**
1. Overview
1. Drupal
1. [Memcache](READMES/drupal-memcache.md)
1. [Content Models and Documentation](READMES/content-models.md)
1. [Centralized Content](READMES/content-model-centralized-content.md)
1. MetalSmith
1. [GraphQL](READMES/graph_ql.md)
1. [Interfaces](READMES/interfaces.md) - APIs and Feature Flag
1. Migrations (data imports)
1. [Facility](READMES/migrations-facility.md)
Expand Down
2 changes: 1 addition & 1 deletion READMES/alerts.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

CMS Alerts are managed by [Sentry](https://sentry.vfs.va.gov/) and [DataDog](https://vagov.ddog-gov.com/).

Runtime issues are reported to Sentry via the Raven module.
[Runtime issues](READMES/sentry.md) are reported to Sentry via the Raven module.

Various metrics in the CI/CD phases and at runtime are reported to DataDog.

Expand Down
5 changes: 1 addition & 4 deletions READMES/blackfire.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ are used by PHP applications. It can be used to measure the performance of a
specific bit of code or an entire request. This allows us to measure the
performance impact of a code or platform change and debug performance issues.

See also:
See also:
* https://ddev.readthedocs.io/en/latest/users/debugging-profiling/blackfire-profiling
* https://blackfire.io/docs/integrations/paas/ddev
* https://blackfire.io/docs/up-and-running/installation (install instructions for non-DDEV environments)
Expand Down Expand Up @@ -69,9 +69,6 @@ Memory 3.62MB
Network n/a n/a n/a
SQL 1.72ms 5rq
```
## Credits
The `blackfire-init.sh` script is based on [this gist](https://gist.github.com/tylerssn/8923149702d4a796c5e103412c2370c3) by @tylerssn.
----
Expand Down
4 changes: 4 additions & 0 deletions READMES/codeowners.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,3 +27,7 @@ The important ideas are:
6. Viewing the CODEOWNERS file in GitHub should provide debugging information.

As with everything else in this project, CODEOWNERS is subject to continual refinement and development. Please raise issues and suggest improvements where appropriate.

----

[Table of Contents](../README.md)
4 changes: 4 additions & 0 deletions READMES/comparing-graphql-output.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,3 +50,7 @@ jq -S '.data.nodeQuery.entities|=sort_by(.entityId)' pages2.json > pages3.json
```

After processing both the "before" and "after" `pages.json` in this way, diffing the two should yield a far more useful visualization of the changes.

----

[Table of Contents](../README.md)
4 changes: 4 additions & 0 deletions READMES/github-workflows.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,3 +23,7 @@ Please follow the following guidelines:
- If you need to check that a given workflow or action still triggers as expected, consider running the scripts `scripts/create-bad-test-files.sh` and `scripts/delete-bad-test-files.sh` to respectively create and delete files that can be used to test lints and checks.

See ["Security hardening for GitHub Actions"](https://docs.github.com/en/actions/security-guides/security-hardening-for-github-actions) for more details concerning GitHub Actions and security.

----

[Table of Contents](../README.md)
File renamed without changes.
2 changes: 1 addition & 1 deletion READMES/sentry.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Sentry

Sentry is used to track errors fom Drupal.
Sentry is used to track errors fom Drupal.

URL: http://sentry.vfs.va.gov/
* Login using your Github Login
Expand Down

0 comments on commit 9cbe310

Please sign in to comment.