search

neurobagel / documentation

The neurobagel documentation
http://neurobagel.org/
MIT License
10 stars 6 forks source link

Describe how to serve and edit docs locally via docker #8

Open surchs opened 1 year ago

surchs commented 1 year ago

See https://squidfunk.github.io/mkdocs-material/creating-your-site/ for description

Based on this, we'll have to make our own Dockerfile that also includes the dependencies needed for the env.

github-actions[bot] commented 1 year ago

We want to keep our issues up to date and active. This issue hasn't seen any activity in the last 30 days. We have applied the stale-issue label to indicate that this issue should be reviewed again and then either prioritized or closed.

alyssadai commented 8 months ago

Hey @surchs, just curious: is this still a someday issue for us, or can we close this? Not sure I see an actual advantage/need to using Docker for the docs.

alyssadai commented 1 month ago

@surchs, any further thoughts on whether we can close this issue?

surchs commented 1 month ago

The main benefit here would be that I don't have to locally create a python environment, install dependencies and then run it just to serve the docs locally / edit the docs locally.

Not a huge deal, but it bothers me enough to keep the issue.

So it's not to serve the prod docs, it's to make developing/changing the docs locally a more seamless experience. E.g. the js dependencies we have to compile the tailwind stylesheets are technically something you would have to install / and occasionally execute to update the css ...