docs: add instructions for running the documentation site locally#4818
docs: add instructions for running the documentation site locally#4818cuixq merged 7 commits intogoogle:masterfrom
Conversation
another-rex
left a comment
There was a problem hiding this comment.
Can you add the dockerfile in osv-scanner, and add that to the instructions? I've always had trouble building directly with bundler.
|
/gemini review |
There was a problem hiding this comment.
Code Review
This pull request introduces instructions and a Dockerfile for running the documentation site locally. The changes to docs/README.md add sections for both Docker-based and native local development, and the new docs/docs.Dockerfile is intended to provide a consistent environment.
My review focuses on improving the new Docker setup. I've identified a critical issue in the Dockerfile where an invalid base image is used, which will prevent it from building. I have also suggested improvements to the README.md instructions to clarify the required working directory and to enhance the docker run command for a better developer experience with live-reloading.
|
We probably can just remove the .bundle copy part. Though @cuixq can you test if you can actually run the docs locally? I seem to be getting conflicts on unable to resolve the dependencies |
|
@another-rex it seems due to the ruby version e.g. commonmarker 0.23.12 has requirement I have modified the docker image to be using |
This PR updates
docs/README.mdto provide clearer instructions for contributors to run and test the documentation site locally in docker or natively.To run documentation site in docker, this PR introduces
docs/docs.Dockerfileto allow consistent local documentation serving without requiring a local Ruby environment.