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

Docker and dgc documentation #101

Open
dc2007git opened this issue Mar 29, 2024 · 1 comment
Open

Docker and dgc documentation #101

dc2007git opened this issue Mar 29, 2024 · 1 comment
Assignees

Comments

@dc2007git
Copy link
Contributor

Working through the documentation I've found a dockerfile that seems redundant. Even in the documentation for loading the documentation, it looks like we don't use it, instead opting for a mkdocs serve approach.

@mbarton are you happy for me to delete the dockerfile in this repo?

@dc2007git dc2007git self-assigned this Mar 29, 2024
@pacharanero
Copy link
Member

The plan here is to merge the documentation site into a subfolder of one of the other repos, this would bring it into line wiht how we do docs for E12. We found that having docs right in the repo with the rest of the code made it more likely that people would update the docs when they updated the code and made changes that users would need to be aware of.

My feeling for which repo we should mrege it into is probably the dGC API server, since this is one that
a) we do usually have running in Docker for local development, hence adding a second container for docs would be easy, and
b) logically the API is a central piece of the dGC stack.

Steps for merging the two are already in an Issue #96 so perhaps this would be a good one to work on next week?

So yes, eventually there will be no need for the Dockerfile in this repo, because we will use docker compose and run it alongside another repo. There will be quite a lot else that can be deleted from this repo (.gitignore, .git, README, requirements, etc) once the merge is done.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants