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

Merge the documentation site into one of the other dGC repos #96

Open
4 of 9 tasks
pacharanero opened this issue Dec 5, 2023 · 1 comment
Open
4 of 9 tasks
Assignees

Comments

@pacharanero
Copy link
Member

pacharanero commented Dec 5, 2023

As we have found with the E12 project, having documentation within the project makes it more likely it will be updated at the time other codebase changes are made.

We should merge this repo into one of the other repos.

The most appropriate one would probably be the dGC server repo itself since this is the 'central product' of the dGC platform and service.

At the point of merging the repos, the other codebase should also be Dockerised, so that both can easily be set up to run in one dev env, simply.

  • Follow the instructions here https://gist.github.com/msrose/2feacb303035d11d2d05 to merge the repos without losing the Git history. Put the documentation site inside a documentation/ folder.
  • Delete the old repo from GitHub
  • Ensure all links which refer to the location of the old repo are updated, everywhere across the other repos
  • Dockerise the destination repo
  • Add the Mkdocs service to the docker-compose.yml of the destination repo
  • create scripts folder and s/up, s/down scripts as needed
  • update deployment GitHub Actions, which currently push the docs site to Azure - this will need to continue but will build from documentation folder. This needs to be done with care because THIS IS A LIVE DOCS/DEMO SITE FOR DGC
  • Test local dev is working, from scratch
  • Test the deployment works
@anchit-chandran
Copy link
Collaborator

Current progress:

  • merged repo
  • dockerized mkdocs (uses separate mkdocs Dockerfile, docker compose builds both server and mkdocs containers). Working from scratch with docker compose up

Left:

  • updating GHActions docs deployment

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

No branches or pull requests

2 participants