Commit b6633a3
authored
docs: add Docker setup for building documentation (#2130)
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 #1869
---------
Signed-off-by: Madduri, Pavan <[email protected]>
Signed-off-by: pmady <[email protected]>1 parent 8b39636 commit b6633a3
File tree
8 files changed
+818
-17
lines changed- .github/workflows
- docs
8 files changed
+818
-17
lines changed| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
55 | 55 | | |
56 | 56 | | |
57 | 57 | | |
58 | | - | |
59 | | - | |
60 | | - | |
61 | | - | |
62 | | - | |
63 | | - | |
| 58 | + | |
| 59 | + | |
64 | 60 | | |
65 | 61 | | |
66 | 62 | | |
| |||
107 | 103 | | |
108 | 104 | | |
109 | 105 | | |
110 | | - | |
| 106 | + | |
| 107 | + | |
| 108 | + | |
| 109 | + | |
| 110 | + | |
| 111 | + | |
111 | 112 | | |
112 | 113 | | |
113 | 114 | | |
| |||
122 | 123 | | |
123 | 124 | | |
124 | 125 | | |
125 | | - | |
126 | | - | |
| 126 | + | |
127 | 127 | | |
128 | 128 | | |
129 | | - | |
| 129 | + | |
130 | 130 | | |
131 | 131 | | |
132 | | - | |
| 132 | + | |
133 | 133 | | |
134 | 134 | | |
135 | 135 | | |
136 | | - | |
| 136 | + | |
137 | 137 | | |
138 | | - | |
| 138 | + | |
139 | 139 | | |
140 | 140 | | |
141 | | - | |
142 | | - | |
| 141 | + | |
| 142 | + | |
| 143 | + | |
| 144 | + | |
| 145 | + | |
| 146 | + | |
| 147 | + | |
143 | 148 | | |
144 | 149 | | |
145 | 150 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
| 21 | + | |
| 22 | + | |
| 23 | + | |
| 24 | + | |
| 25 | + | |
| 26 | + | |
| 27 | + | |
| 28 | + | |
| 29 | + | |
| 30 | + | |
0 commit comments