-
Notifications
You must be signed in to change notification settings - Fork 235
[docs] Add Docker setup for building documentation #2130
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
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
Add comprehensive Docker-based setup for building OpenCue documentation without requiring local Ruby installation. This provides multiple interfaces (helper script, Make, Docker Compose, direct Docker) to accommodate different workflows and ensures consistent build environments across all platforms. Changes: - Add Dockerfile with Ruby 3.2 Alpine base image - Add docker-compose.yml with build, serve, and ci profiles - Add docker-build.sh helper script with fallback support - Add Makefile for Make-based Docker commands - Add .dockerignore for optimized builds - Add DOCKER.md with comprehensive documentation - Add DOCKER_SETUP_SUMMARY.md for implementation details - Update README.md to recommend Docker setup as Option 1 Features: - No Ruby installation required - Live reload development server - Persistent gem caching for faster builds - CI/CD ready with clean build profile - Backward compatible with local Ruby setup - Supports Docker Compose v1, v2, or direct Docker commands Issue Number: close AcademySoftwareFoundation#1869 Signed-off-by: Madduri, Pavan <pavan.madduri@grainger.com>
lithorus
requested changes
Dec 23, 2025
Collaborator
lithorus
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Really nice setup.
Seems to work as intended, but perhaps you could also add it to CI/CD?
…tion Address review feedback from @lithorus: - Remove DOCKER_SETUP_SUMMARY.md as it's not needed for the PR - Update docs-pipeline.yml to use Docker for building documentation Changes: - Remove docs/DOCKER_SETUP_SUMMARY.md - Update .github/workflows/docs-pipeline.yml to use Docker Buildx - Replace Ruby setup with Docker build process - Use docker run to build documentation in CI/CD This ensures the Docker setup is properly integrated into the existing CI/CD pipeline and provides a consistent build environment. Issue Number: ref AcademySoftwareFoundation#1869 Signed-off-by: pmady <pavan4devops@gmail.com>
Contributor
Author
|
Included the docker set-up in github workflow After |
lithorus
approved these changes
Dec 26, 2025
Collaborator
|
Thanks, @pmady Great job! |
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.
Link the Issue(s) this Pull Request is related to.
Summarize your change.
Add a comprehensive Docker-based setup for building OpenCue documentation without requiring a local Ruby installation. This provides multiple interfaces (helper script, Make, Docker Compose, and direct Docker) to accommodate different workflows and ensure consistent build environments across all platforms.
Changes:
Features: