Skip to content

Conversation

@dennisvang
Copy link
Contributor

@dennisvang dennisvang commented Aug 28, 2025

fixes #57
fixes #104

@dennisvang dennisvang changed the title Update deployment section Update "deployment" section Aug 28, 2025
@dennisvang dennisvang added this to the 1.17 update milestone Aug 29, 2025
@dennisvang
Copy link
Contributor Author

To prevent duplication and stale examples, I think it would be best to link directly to the content of the FAIRDataTeam/compose repo. This can be done with the help of the sphinx literalinclude directive, as long as we have access to the compose files during build.

There are several ways to achieve this:

  • add a build step that clones the repo or pulls the relevant files into a local directory
  • include the repo as a git submodule
  • include the repo as a git subtree
  • (perhaps link directly to files on github? not sure if this is possible with sphinx and restructuredtext)
  • ...

Of these options, I think git submodule is probably the best fit, because it makes our intention very explicit.
Submodules can be tricky, but I think our use case is quite straightforward.
Moreover, readthedocs also supports submodules.

@luizbonino luizbonino marked this pull request as ready for review August 29, 2025 16:42
@luizbonino
Copy link
Member

I like the idea of the submodule.

@dennisvang dennisvang marked this pull request as draft September 1, 2025 08:28
@dennisvang dennisvang force-pushed the maintenance/issue63 branch 2 times, most recently from b526b2e to e7d1c88 Compare September 3, 2025 14:20
@dennisvang dennisvang changed the title Update "deployment" section Update production deployment section Oct 27, 2025
@dennisvang dennisvang force-pushed the maintenance/issue63 branch 2 times, most recently from 703240a to 285a65f Compare November 3, 2025 16:03
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

Successfully merging this pull request may close these issues.

Update production deployment instructions Specify container dependencies in docker compose instructions

3 participants