[documentation / submitty.org] Containerize documentation site#748
Closed
Pavan-Srivathsa wants to merge 2 commits into
Closed
[documentation / submitty.org] Containerize documentation site#748Pavan-Srivathsa wants to merge 2 commits into
Pavan-Srivathsa wants to merge 2 commits into
Conversation
Pavan-Srivathsa
force-pushed
the
containerize-docs-site
branch
from
940ade1 to
b436c07
Compare
Member
|
Hi @Pavan-Srivathsa, thanks for this contribution. Unfortunately it looks like there's an error with the host configuration. I see the following in the console when I follow the directions listed in this PR: |
williamjallen
requested changes
Apr 30, 2026
williamjallen
left a comment
williamjallen
left a comment
Member
There was a problem hiding this comment.
Requesting changes as per above comment.
github-project-automation
Bot
moved this from Seeking Reviewer
to Work in Progress
in Submitty Development
Member
|
Closing due to lack of response. |
bmcutler
pushed a commit
that referenced
this pull request
Jul 15, 2026
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. This avoids the need to have the proper versions of Ruby and Bundler installed locally. ### What steps should a reviewer take to test? 1. checkout the branch 2. Run ` docker compose up` 3. verify the site loads at http://localhost:4000 4. verify that changes made to the md files in _docs are applied with an automatic reload 5. verify that the link checker commands mentioned in the readme work as expected ### Automated 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. Aka, you would not actually be visiting http://localhost:4000 In the new PR, a _config_docker.yml file is added to make sure the link is properly set to http://localhost:4000 --------- Co-authored-by: Pavan <pavan33.srivathsa@gmail.com> Co-authored-by: Pavan-Srivathsa <62050941+Pavan-Srivathsa@users.noreply.github.com>
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.
Why is this Change Important & Necessary?
Building the documentation site requires installing Ruby and managing
gem dependencies locally, which is painful for infrequent contributors
(as noted in Submitty/Submitty#12685). Ruby version conflicts and native
extension compilation failures are common pain points.
What is the New Behavior?
Contributors can now run the documentation site with a single command:
docker compose up
No Ruby, Bundler, or gem installation required. The setup includes:
What steps should a reviewer take to test?
docker compose up --build_docs/and confirm the browser refreshesdocker compose down && docker compose upto confirm fast restartdocker compose exec docs bundle exec jekyll build
docker compose exec docs bundle exec htmlproofer ./_site --assume-extension --empty-alt-ignore --disable_external
Automated Testing & Documentation
README.md updated with Docker setup instructions. Existing Ruby/Bundler
instructions preserved. No automated test changes needed.
Other information
Not a breaking change. No migrations required.
Resolves Submitty/Submitty#12685