[documentation / submitty.org] Containerize documentation site#748
Open
Pavan-Srivathsa wants to merge 1 commit intoSubmitty:mainfrom
Open
[documentation / submitty.org] Containerize documentation site#748Pavan-Srivathsa wants to merge 1 commit intoSubmitty:mainfrom
Pavan-Srivathsa wants to merge 1 commit intoSubmitty:mainfrom
Conversation
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.
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