docs: expand deployment asset overview#3248
Open
ming1523 wants to merge 1 commit intoFuelLabs:masterfrom
Open
Conversation
PR SummaryLow Risk Overview Adds basic usage examples for building the node and e2e client images and running the node via Written by Cursor Bugbot for commit c365450. This will update automatically on new commits. Configure here. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
deployment/README.mdfrom a one-line overview into a usable deployment entrypointDockerfile,e2e-client.Dockerfile, anddocker-compose.ymldocker composeusage examples from the repository rootdeployment/Why
Compared with other infrastructure repositories,
fuel-corealready 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
This is a docs-only change. The
no changeloglabel seems appropriate if maintainers agree.