Skip to content

docs: expand deployment asset overview#3248

Open
ming1523 wants to merge 1 commit intoFuelLabs:masterfrom
ming1523:docs-deployment-assets
Open

docs: expand deployment asset overview#3248
ming1523 wants to merge 1 commit intoFuelLabs:masterfrom
ming1523:docs-deployment-assets

Conversation

@ming1523
Copy link
Copy Markdown

@ming1523 ming1523 commented Apr 1, 2026

Summary

  • expand deployment/README.md from a one-line overview into a usable deployment entrypoint
  • document the purpose of Dockerfile, e2e-client.Dockerfile, and docker-compose.yml
  • add minimal build and docker compose usage examples from the repository root
  • clarify that Kubernetes manifests are not currently stored in deployment/

Why

Compared with other infrastructure repositories, fuel-core already ships container assets but the deployment directory did not explain how they fit together. This makes the repository harder to approach for operators and contributors trying to understand the container-based workflow.

Validation

  • verified all referenced files exist in the current tree
  • docs-only change, no runtime behavior changed

This is a docs-only change. The no changelog label seems appropriate if maintainers agree.

@cursor
Copy link
Copy Markdown

cursor bot commented Apr 1, 2026

PR Summary

Low Risk
Docs-only update with no changes to runtime behavior; risk is limited to potential confusion if instructions drift from the actual Docker assets.

Overview
Expands deployment/README.md from a one-line note into a short guide describing the purpose of the fuel-core and fuel-core-e2e-client container build assets.

Adds basic usage examples for building the node and e2e client images and running the node via docker compose, and clarifies that Kubernetes manifests are not included here (linking to operator docs).

Written by Cursor Bugbot for commit c365450. This will update automatically on new commits. Configure here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant