Skip to content

Clarify that deployment guides are examples - #2464

Merged
kmcginnes merged 2 commits into
mainfrom
t3/implement-issue-2460
Oct 26, 2026
Merged

kmcginnes merged 2 commits into
mainfrom
t3/implement-issue-2460

Conversation

@kmcginnes

Copy link
Copy Markdown
Collaborator

Summary

The deployment guides read like recommended setups, so each now says it is an example and points to the supported hosting model and general AWS guidance.

User-facing: the Docker, EC2, ECS Fargate and SageMaker guides open with a note that the guide is not a recommended production configuration.

 docs/
 ├── guides/
+│   ├── deploy-with-docker.md       # example paragraph
+│   ├── deploy-to-ec2.md            # example paragraph, replaces its own wording
+│   ├── deploy-to-ecs-fargate.md    # example paragraph
+│   └── deploy-to-sagemaker.md      # example paragraph
 ├── references/
+│   └── security.md                 # matching paragraph under Access Control
 └── agents/
+    └── documentation.md            # new deployment guides must carry it

Merge Danger

Door: two-way

The #supported-hosting links point at a section that Document the supported hosting model (#2459) adds, so merge after it.

Impact: docs only

Related

Layer: 1-deployment-guide-examples
@kmcginnes
kmcginnes force-pushed the t3/implement-issue-2460 branch from 5ff08e2 to f887b39 Compare October 26, 2026 23:04

@kmcginnes kmcginnes left a comment

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approved

@kmcginnes
kmcginnes merged commit 8d8a47d into main Oct 26, 2026
1 check passed
@kmcginnes
kmcginnes deleted the t3/implement-issue-2460 branch October 26, 2026 23:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Clarify that deployment guides are examples

1 participant