“Dogfooding” or “eating our own dog food” refers to the practice of using our own product. This is important because it enables us to continuously test the same experience that our users will use on the day of the workshop.
Setup¶
You’ll need to be familiar with the following processes:
Once you’ve set up GitHub authentication, you can use Git normally.
Previewing the MyST site¶
We have installed
jupyter-myst-build-proxy
which builds the MyST site on-demand.
See 📝 Using MyST for instructions.
Tradeoffs¶
This extension uses the myst build --html command instead of myst start
(read more here).
As a consequence, builds are not triggered automatically when edits are performed.
There is currently no known way to use the MyST preview server myst start in a
JupyterLab environment. See jupyter
Pros¶
User doesn’t need to run anything in the terminal to build their site
Handles BASE_URL concerns implicitly
Cons¶
Not portable to local usage after the workshop
Builds only occur when manually triggered