diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 78e7a43..ddba9a4 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -4,7 +4,8 @@ Thanks for your interest in `@dwk/workers` — a pnpm-workspace monorepo of composable npm packages that each implement an open web standard and run as [Cloudflare Workers](https://developers.cloudflare.com/workers/) on an end user's **own** account. Start with the [README](./README.md) for what the -project is; this document covers how to work on it. +project is; this document covers how to work on it. If you operate a deployed +site rather than develop the packages, see the [IT guide](./docs/it-guide.md). ## Ground rules @@ -222,7 +223,9 @@ cannot publish a stable version until its suites in ## Reporting bugs & security issues - Open a [GitHub issue](https://github.com/davidwkeith/workers/issues) with - reproduction steps and the package + version affected. + reproduction steps and the package + version affected. For a deployed site, + the [IT guide](./docs/it-guide.md#4-getting-help) lists the redacted log + details worth including. - Production errors reported automatically by Anglesite sites arrive as `source:anglesite-issues` issues and are triaged by an agent. See [docs/anglesite-issue-triage.md](./docs/anglesite-issue-triage.md). diff --git a/spec/README.md b/spec/README.md index ff15c92..f807c92 100644 --- a/spec/README.md +++ b/spec/README.md @@ -6,6 +6,10 @@ into focused technical specifications. The issue is the source of truth for **scope**; these documents are the source of truth for **how** each piece is built and what "done" means. +Operating a deployed site rather than building the packages? The +[IT guide](../docs/it-guide.md) covers the same architecture from an operator's +side and how to debug it against your own Cloudflare configuration. + ## Reading order | # | Document | Covers |