feat: add containerized mkdocs-dev instruction #25
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.
Containing a doc_env/Dockerfile to make sure dev env consistency and a description document doc_env/README.md.
Description
This PR adds a containerized development environment for MkDocs in the Openadkit project. It introduces a
Dockerfileand aREADME.mdin thedoc_env/directory, providing instructions to build and run a MkDocs development server. The setup replicates the dependencies from the GitHub Actions workflow, ensuring consistency between local and CI/CD environments.doc_env/Dockerfileto create a Python 3.11-based image with required MkDocs plugins.doc_env/README.mdwith detailed instructions for building, running, and troubleshooting the containerized environment.How was this PR tested?
docker build -f doc_env/Dockerfile -t mkdocs-dev ..docker run -it --rm -p 8000:8000 -v $(pwd):/app mkdocs-devand verified the MkDocs site loads athttp://localhost:8000.docker run -it --rm -v $(pwd):/app mkdocs-dev mkdocs buildand confirmed thesite/directory was created correctly..dockerignorefile to exclude unnecessary directories (e.g.,deployments/,.github/).Notes for reviewers
.dockerignorerecommendations indoc_env/README.mdto ensure optimal build performance.DockerfileomitsCOPYinstructions formkdocs.ymlanddocs/to avoid hardcoding file paths, relying on volume mounts for flexibility. Confirm if this approach aligns with project needs.Effects on system behavior
None. This PR only adds documentation and development tools without affecting existing project functionality.