Oliver Bertuch (May 04 2023 at 13:18): Oliver Bertuch (May 04 2023 at 13:18):And we didn't even fulfill all of milestone A yet :see_no_evil: Anyone up for docs writing?
Philip Durbin 🚀 (May 04 2023 at 13:40):@Oliver Bertuch if you start the branch and (eventually) make the pull request, I'll contribute to it!
Here's a handy link to the issue: https://github.com/IQSS/dataverse/issues/9540
Maybe you could explain how to view logs? That's probably one of the easier bullets.
Oliver Bertuch (May 04 2023 at 13:42):D'oh! I thought I wouldn't need to write docs :grimacing:
Philip Durbin 🚀 (May 04 2023 at 16:15):Here's a diff to get you started:
$ git diff
diff --git a/doc/sphinx-guides/source/container/dev-usage.rst b/doc/sphinx-guides/source/container/dev-usage.rst
index 4eba70eb23..4a12902c06 100644
--- a/doc/sphinx-guides/source/container/dev-usage.rst
+++ b/doc/sphinx-guides/source/container/dev-usage.rst
@@ -49,3 +49,7 @@ You can also access the Payara Admin Console if needed, which is available at ht
Note that data is persisted in ``./docker-dev-volumes`` in the root of the Git repo. For a clean start, you should
remove this directory before running the ``mvn`` commands above.
+
+To view the Payara server.log file:
+
+``docker logs dataverse-1``
You could just call the branch 9540-docs.
Philip Durbin 🚀 (May 04 2023 at 16:16):In the main repo, please.
Philip Durbin 🚀 (May 04 2023 at 16:16):Then I'm happy to add more commits.
Philip Durbin 🚀 (May 08 2023 at 11:17):Oh, we don't need a single PR to fix all the docs stuff at once. We can merge as we go. Instead of "closes" we can say "related to".
Oliver Bertuch (May 08 2023 at 11:28):Here's a thought: how about we add more docs about containers to the container guide, remove the "Docker, Kubernetes and Containers" page from the Dev guide and create a new Dev Guide page on "Continuous Integration", that can hold all of our stuff we do with GH actions now and in the future? (So we move and update the CI part in http://preview.guides.gdcc.io/en/develop/developers/testing.html#continuous-integration into it, which is grossly outdated, mentioning Phoenix et al)
Philip Durbin 🚀 (May 08 2023 at 11:32):A new page in the dev guide on CI where we can talk about GitHub Actions sounds good.
Philip Durbin 🚀 (May 08 2023 at 11:33):I don't feel strongly about removing the old containers page. It serves a useful purpose of directing people to the new Container Guide.
Oliver Bertuch (May 10 2023 at 11:54):Question @Philip Durbin: in milestone A we say "explain how to redeploy"
Oliver Bertuch (May 10 2023 at 11:55):Would it help to explain how to run the containers in background?
Oliver Bertuch (May 10 2023 at 11:55):Maybe also explain how to just run the app container in foreground?
Oliver Bertuch (May 10 2023 at 11:55):Or restart just this one when it's in background?
Oliver Bertuch (May 10 2023 at 11:56):I feel it's getting more and more containers and all of those take obviously time to start
Philip Durbin 🚀 (May 10 2023 at 11:56):Yes, I think @Jan Range requested that -d be documented.
Oliver Bertuch (May 10 2023 at 11:57):That's compose syntax
Oliver Bertuch (May 10 2023 at 11:57):Do we want compose syntax?
Oliver Bertuch (May 10 2023 at 11:57):For the redeploy you need Maven anyway
Oliver Bertuch (May 10 2023 at 11:57):(Recompile, rebuild, ...)
Philip Durbin 🚀 (May 10 2023 at 11:58):Yes, like the issue says, we want to write about vanilla docker compose syntax.
Oliver Bertuch (May 10 2023 at 11:59):Looks like I need to read the issue :-D
Oliver Bertuch (May 10 2023 at 11:59):I was reading our milestone again :-D
Philip Durbin 🚀 (May 10 2023 at 12:00):The issue is living. :happy:
Oliver Bertuch (May 10 2023 at 12:00):Yeah...
Oliver Bertuch (May 10 2023 at 12:01):Hard part: if you start via compose you won't be able to replace the app container via mvn
Oliver Bertuch (May 10 2023 at 12:02):OK that's not completely true - you can of course make it two commands, then that will work as well
Philip Durbin 🚀 (May 10 2023 at 12:09):I'm definitely interested in trying that "watch" thing you added. I forget if I told you but I'm slowly working on using the Maven Docker Plugin for the people app. Maybe we can play with watch there: https://github.com/IQSS/dataverse-people/compare/docker-build-scratch
Philip Durbin 🚀 (May 10 2023 at 12:10):Right now for both "people" and Dataverse, I just redeploy the dumb way.
Oliver Bertuch (May 10 2023 at 12:20):That is not the "hard way" :smile:
Oliver Bertuch (May 10 2023 at 12:21):But yeah, I'd be interested in trying out watch
Oliver Bertuch (May 10 2023 at 12:21):I'm not sure this is going to work out because the Dockerfile has the knowledge about where to place the files. So maybe "copy" mode won't work.
Oliver Bertuch (May 10 2023 at 12:22):But I do have an idea involving mounting the exploded dir into the container. Try hot reload from the container
Oliver Bertuch (May 10 2023 at 12:22):And of course there is JRebel :smile:
Philip Durbin 🚀 (May 10 2023 at 12:25):Lots of ways to improve over what I'm doing now. :sweat_smile:
Oliver Bertuch (May 10 2023 at 12:43):Question: I'm writing up the different ways of running this
Oliver Bertuch (May 10 2023 at 12:43):Do we want some ascii cinema examples?
Oliver Bertuch (May 10 2023 at 12:44):So people get an idea of what things look like?
Oliver Bertuch (May 10 2023 at 12:44):http://hhoegl.informatik.hs-augsburg.de/es2/sphinx-asciinema/_build/html/main.html
Philip Durbin 🚀 (May 10 2023 at 12:58):I'd probably wait on that, especially if it adds a Sphinx dependency.
Oliver Bertuch (May 10 2023 at 13:00):https://github.com/IQSS/dataverse/pull/9584
Philip Durbin 🚀 (May 10 2023 at 13:03):Thanks! I'm on the branch poking around!
Philip Durbin 🚀 (May 10 2023 at 13:04):In the backlog I replaced the issue with the PR.
Oliver Bertuch (May 10 2023 at 13:05):Where should we drop the notes about running SMTP only? Sound like Dev Guide to me...
Oliver Bertuch (May 10 2023 at 13:05):Here's the preview BTW https://dataverse-guide--9584.org.readthedocs.build/en/9584/container/dev-usage.html
Philip Durbin 🚀 (May 10 2023 at 13:06):We should probably edit this:
The installer will try to connect to the SMTP server you tell it to use. If you haven’t used the Docker Compose option for setting up the dependencies, or you don’t have a mail server handy, you can run nc -l 25 in another terminal and choose “localhost” (the default) to get past this check.
Philip Durbin 🚀 (May 10 2023 at 13:07):Over at https://dataverse-guide--9584.org.readthedocs.build/en/9584/developers/dev-environment.html
Oliver Bertuch (May 10 2023 at 13:08):Sounds good to me
Oliver Bertuch (May 10 2023 at 13:08):Lemme know what you think about the tables.
Philip Durbin 🚀 (May 10 2023 at 13:10):They look good but we might want a quickstart at the top.
Philip Durbin 🚀 (May 10 2023 at 13:11):An opinionated quickstart. Just do this.
Philip Durbin 🚀 (May 10 2023 at 13:11):And then show the tables below.
Oliver Bertuch (May 10 2023 at 13:11):Ok I'll add a tl;dr in the intro
Philip Durbin 🚀 (May 10 2023 at 13:14):Should we mention that the build step isn't necessary if you pull from Docker Hub or GHCR?
Oliver Bertuch (May 10 2023 at 13:15):No I wouldn't do that
Oliver Bertuch (May 10 2023 at 13:15):This guide is targeted towards people doing Java dev work
Oliver Bertuch (May 10 2023 at 13:16):For the occasional drop-by we might write some other guide
Oliver Bertuch (May 10 2023 at 13:16):And probably want some other compose file
Oliver Bertuch (May 10 2023 at 13:16):Let's tune this heavily towards a "real dev"
Oliver Bertuch (May 10 2023 at 13:17):And for integrators we definitely need a different page
Philip Durbin 🚀 (May 10 2023 at 13:26):Ok. This is coming: https://github.com/IQSS/dataverse-frontend/blob/eaf26512eb414f79cbefc0fe4389ce478016f59c/README.md#local-development-environment
Philip Durbin 🚀 (May 10 2023 at 13:26):Which mentions containers. We can link to it.
Oliver Bertuch (May 10 2023 at 14:14):@Philip Durbin what was that all about?
Update Windows dev page: https://guides.dataverse.org/en/5.13/developers/windows.html A cloned Dataverse by Git for Windows with the line-ending setting is set to always LF (core.autocrlf=input)
Philip Durbin 🚀 (May 10 2023 at 14:15):You can leave that Windows page to me.
Oliver Bertuch (May 10 2023 at 14:17):You might have seen I turned https://github.com/IQSS/dataverse/issues/9540 into a checklist...
Philip Durbin 🚀 (May 10 2023 at 14:18):I hadn't but looks great, thanks.
Oliver Bertuch (May 10 2023 at 14:20):Do you want to document the SMTP part as well? You played around a little with it...
Philip Durbin 🚀 (May 10 2023 at 14:41):Yes, I'm happy to.
Philip Durbin 🚀 (May 10 2023 at 14:42):You've written a ton of docs! Thank you! A stub would have been enough! Much appreciated!
Oliver Bertuch (May 10 2023 at 14:43):I'm even looking into writing about redeployment aside from stopping 'em all and starting 'em all again
Oliver Bertuch (May 10 2023 at 16:16):Moved the discussion about redeployment options to #containers > faster redeploy
Oliver Bertuch (May 31 2023 at 13:29):@Philip Durbin what do we do with https://github.com/IQSS/dataverse/pull/9584 ?
Oliver Bertuch (May 31 2023 at 13:30):(I merged develop and solved the conflict)
Philip Durbin 🚀 (May 31 2023 at 13:31):I guess I'm thinking...
Oliver Bertuch (May 31 2023 at 13:36):Hmm can we get on the fast lane with this docs only PR? It's just our (=container) docs...
Philip Durbin 🚀 (May 31 2023 at 13:37):There's a good chance, yes.
Oliver Bertuch (Jun 01 2023 at 17:05):I updated the docs with the latest changes from develop (configbaker image), solving the merge conflicts
Oliver Bertuch (Jun 01 2023 at 17:06):Here's the preview of the dev usage page: https://dataverse-guide--9584.org.readthedocs.build/en/9584/container/dev-usage.html
Philip Durbin 🚀 (Jun 01 2023 at 20:52):Looks good but I may turn that tl;dr into a quickstart
Philip Durbin 🚀 (Jun 01 2023 at 20:52):Thanks for resolving the merge conflicts!
Oliver Bertuch (Jun 01 2023 at 20:58):I'd rather have the quickstart after the intro, as it lists the prerequisites (Docker, Java, Maven)
Philip Durbin 🚀 (Jun 01 2023 at 21:10):In the frontend README only Docker is required. Even quicker! :happy:
Oliver Bertuch (Jun 01 2023 at 21:13):Yeah well suppose they don't need to wrestle with all sorts of stuff being moved around...
Oliver Bertuch (Jun 12 2023 at 20:33):@Philip Durbin what are we gonna do with https://github.com/IQSS/dataverse/pull/9584 now after DCM and probably close to 5.14?
Philip Durbin 🚀 (Jun 12 2023 at 20:34):I should get on that branch and hack a bit.
Oliver Bertuch (Jun 12 2023 at 20:34):Ha! That's true!
Oliver Bertuch (Jun 12 2023 at 20:35):I should probably go ahead and hack on mail stuff to solve Milestone C
Philip Durbin 🚀 (Jun 12 2023 at 20:35):During the demo, you showed the preview of that PR, right?
Oliver Bertuch (Jun 12 2023 at 20:35):Nope. That was about MPCONFIG for OIDC
Philip Durbin 🚀 (Jun 12 2023 at 20:36):Oh. Well, I guess the docs in develop were good enough then :sweat_smile:
Philip Durbin 🚀 (Jun 12 2023 at 20:36):for demo purposes
Oliver Bertuch (Jun 12 2023 at 20:36):Dunno if that is going to make it into 5.14 or 6.1 :smile:
Oliver Bertuch (Jun 12 2023 at 20:36):Yes, exactly - show the integration with Keycloakl
Oliver Bertuch (Jun 12 2023 at 20:37):It would be nice to have that in 5.14 but I suppose you folks don't want more on your plates
Philip Durbin 🚀 (Jun 20 2023 at 13:03):Check out https://github.com/IQSS/dataverse/pull/9584#issuecomment-1596320823
Philip Durbin 🚀 (Aug 11 2023 at 09:47):https://github.com/IQSS/dataverse/pull/9584 was merged as part of 5.14, now released. Good job, all.
Notification Bot (Aug 11 2023 at 09:47):Philip Durbin has marked this topic as resolved.
Last updated: Oct 30 2025 at 05:14 UTC