From 9cbe3108023fb91331e3ad9d54c0b129b826c7f8 Mon Sep 17 00:00:00 2001 From: John Luo Date: Wed, 29 Nov 2023 18:47:12 -0500 Subject: [PATCH] Add links to some orphan docs --- README.md | 7 +++++-- READMES/alerts.md | 2 +- READMES/blackfire.md | 5 +---- READMES/codeowners.md | 4 ++++ READMES/comparing-graphql-output.md | 4 ++++ READMES/github-workflows.md | 4 ++++ READMES/{ => historical}/analytics.md | 0 READMES/sentry.md | 2 +- 8 files changed, 20 insertions(+), 8 deletions(-) rename READMES/{ => historical}/analytics.md (100%) diff --git a/README.md b/README.md index e2c69e49077..c3ef02c9eea 100644 --- a/README.md +++ b/README.md @@ -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) @@ -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) diff --git a/READMES/alerts.md b/READMES/alerts.md index 0c1e4ffd52c..9b24c37babd 100644 --- a/READMES/alerts.md +++ b/READMES/alerts.md @@ -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. diff --git a/READMES/blackfire.md b/READMES/blackfire.md index 3c66f987533..58578737f97 100644 --- a/READMES/blackfire.md +++ b/READMES/blackfire.md @@ -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) @@ -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. ---- diff --git a/READMES/codeowners.md b/READMES/codeowners.md index 9f75f6e3654..1371ebab57a 100644 --- a/READMES/codeowners.md +++ b/READMES/codeowners.md @@ -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) \ No newline at end of file diff --git a/READMES/comparing-graphql-output.md b/READMES/comparing-graphql-output.md index 0c7a3785003..4a9faea8eac 100644 --- a/READMES/comparing-graphql-output.md +++ b/READMES/comparing-graphql-output.md @@ -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) \ No newline at end of file diff --git a/READMES/github-workflows.md b/READMES/github-workflows.md index e092ee5000b..6f48aa51b0b 100644 --- a/READMES/github-workflows.md +++ b/READMES/github-workflows.md @@ -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) \ No newline at end of file diff --git a/READMES/analytics.md b/READMES/historical/analytics.md similarity index 100% rename from READMES/analytics.md rename to READMES/historical/analytics.md diff --git a/READMES/sentry.md b/READMES/sentry.md index cf5e0771e07..763e5d9b37d 100644 --- a/READMES/sentry.md +++ b/READMES/sentry.md @@ -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