Details
-
Sub-task
-
Status: Resolved
-
Minor
-
Resolution: Fixed
-
None
-
None
Description
Building docusaurus sites requires installing a node package manager (npm, yarn, pnpm), and installing all dependencies on your machine (a few hundred MB). While this is suitable for doing production builds of the site, users who just want to quickly preview their docs changes may prefer a lighter weight option. This jira proposes:
1. Adding a Dockerfile to build an image with the website dependencies included.
2. Adding a docker compose file to run the website in development mode with the source code mounted as a volume. The preview would be viewable on localhost:3000 the same as if it were running natively on the machine.
This way, previewing changes with hot reload would only require the user running docker compose up. The space occupied by the dependencies could be cleared out by deleting the docker image, which would be automatically rebuilt if needed on the next invocation.
Currently, I don't see much advantage to containerizing the production build of the website since that will be deployed using apache infrastructure, so the scope of this Jira is limited to the development server.
Attachments
Issue Links
- links to