Skip to content

Add script to locally serve MkDocs site through docker

homotechsual requested to merge github/fork/seancolsen/docker into master

Created by: seancolsen

This is a first stab at using Docker to make it easier for people to preview the Dev Guide locally. I'd like some feedback from others about the idea of including this script in this repo (and potentially other repos like the User Guide). @mickadoo @PalanteJon @ErichBSchulz (Docker fans I know) do any of you have thoughts on this? The idea here is that if someone has git and Docker installed locally then they can run this new script ./docker-mkdocs-serve to preview the book locally and then edit (without needing to install pip, mkdocs, etc).

Concerns/questions:

  • Would this script even be useful to anyone? Maybe not. If they can install git and Docker it's only a small leap to install the other packages. OTOH, I've seen a lot of people have challenges getting MkDocs working locally. Maybe there would be some people who benefit from using this script?
  • Is my approach a good one? I'm new to Docker. The goal here is to use Docker to make it easier for people to run mkdocs serve, but am I really using Docker the right way here? Not sure about that. Note that there's no Dockerfile here. My approach is to use a custom public image hosted on Docker Hub which I built to have MkDocs and other dependencies that our docs books require.

Merge request reports