Repository navigation
Update deployment instructions - #159
Merged
Merged
Conversation
There was a problem hiding this comment.
🟢 Approval recommended
The documentation aligns with the existing workflow, with no unresolved findings.
No open issues 🎉
What changed in this PR
Updates deployment documentation to reflect the Docker-based build workflow. The website itself is unchanged.
Changes:
- Presents Docker Compose as the primary way to run the project.
- Moves static-site build instructions into the deployment section.
- Corrects the hosting docroot to use the contents of the
livebranch.
| File | Description |
|---|---|
| README.md | Reorganizes run/build instructions and corrects deployment setup. |
Review effort: Balanced
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.
This changeset updates the deployment instructions now that #158 builds the website with Docker. Running the project in a production-like container comes first, and building the static website with
makemoves to the deployment section.It also fixes the docroot in the continuous deployment instructions, as this project has no
public/directory. Documentation only, the website itself is unchanged.Builds on top of #158, #147, #146, #127 and #125
Refs https://github.com/clue-engineering/eventbridge/pull/21 (private) and clue/framework-x-website#37