Skip to content

[Feature:Developer] Containerize docs site#767

Open
roye2 wants to merge 9 commits into
mainfrom
containerize-docs-site
Open

[Feature:Developer] Containerize docs site#767
roye2 wants to merge 9 commits into
mainfrom
containerize-docs-site

Conversation

@roye2

@roye2 roye2 commented Jul 9, 2026

Copy link
Copy Markdown
Contributor

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

@github-project-automation github-project-automation Bot moved this to Seeking Reviewer in Submitty Development Jul 9, 2026
@roye2 roye2 changed the title Containerize docs site [Feature:Developer] Containerize docs site Jul 9, 2026
@roye2 roye2 marked this pull request as ready for review July 9, 2026 21:11

@dagemcn dagemcn left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I tested this on Mac with Opera, I was able to verify that the docker container builds and runs successfully. I also tested the live reload feature which works as intended.

@github-project-automation github-project-automation Bot moved this from Seeking Reviewer to Awaiting Maintainer Review in Submitty Development Jul 13, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Awaiting Maintainer Review

Development

Successfully merging this pull request may close these issues.

Containerize documentation site

3 participants