[Feature:Developer] Containerize docs site#767
Open
roye2 wants to merge 5 commits into
Open
Conversation
roye2
changed the title
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
2 participants
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.
See PR #748 .
Closes Submitty/Submitty#12685
Why is this change important and necessary?
Building the site requires installing Ruby locally and managing gem dependencies / versions. Containerizing the development website will make it easier for developers to test the site.
What is the new behavior?
You can now run the site with
docker compose upWhat steps should a reviewer take to test?
docker compose up --buildAutomated Testing and Documentation
Other information
What is different about this new PR over #748:
In PR #748, there was an issue where, when connecting to the server, it would put you on the port 0.0.0.0 and thus the browser would complain that the website was not secure.
In the new PR, nginx is used to communicate with the host machine as a proxy. You can visit the site at http://localhost:4000 normally and that is the url that will be displayed in your browser.