Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
surchs opened this issue May 9, 2023 · 4 comments
Open

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

surchs opened this issue May 9, 2023 · 4 comments
Labels
documentation Changes only affect the documentation someday Not a priority right now, but we want to keep this around to think or discuss more.

Comments

@surchs
Copy link
Contributor

surchs commented May 9, 2023

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.

@surchs surchs added this to Neurobagel May 9, 2023
@surchs surchs added the documentation Changes only affect the documentation label May 9, 2023
@github-actions
Copy link

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.

@github-actions github-actions bot added the _flag:stale [BOT ONLY] Flag issue that hasn't been updated in a while and needs to be triaged again label Aug 17, 2023
@surchs surchs added the someday Not a priority right now, but we want to keep this around to think or discuss more. label Aug 22, 2023
@github-actions github-actions bot removed the _flag:stale [BOT ONLY] Flag issue that hasn't been updated in a while and needs to be triaged again label Aug 23, 2023
@alyssadai
Copy link
Contributor

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 alyssadai added flag:discuss Flag issue that needs to be discussed before it can be implemented. flag:schedule Flag issue that should go on the roadmap or backlog. and removed flag:discuss Flag issue that needs to be discussed before it can be implemented. flag:schedule Flag issue that should go on the roadmap or backlog. labels Mar 26, 2024
@alyssadai
Copy link
Contributor

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

@surchs
Copy link
Contributor Author

surchs commented Sep 25, 2024

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 ...

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Changes only affect the documentation someday Not a priority right now, but we want to keep this around to think or discuss more.
Projects
Status: No status
Development

No branches or pull requests

2 participants