Oliver Bertuch (Sep 20 2023 at 09:51): Oliver Bertuch (Sep 20 2023 at 09:51):Philipp Conzet asked on the mailing list https://groups.google.com/g/dataverse-community/c/InYj4VR_W9o for help with migration of the GDCC homepage to Github Pages
Philipp Conzett (Sep 20 2023 at 09:59):Thanks Oliver. How should we proceed to get a GDCC GitHub page up and running?
Oliver Bertuch (Sep 20 2023 at 10:00):Hi @Philipp Conzett and welcome :smile:
Oliver Bertuch (Sep 20 2023 at 10:00):Do you folks still have the old content saved or do we need to scrape it of archive.org?
Philipp Conzett (Sep 20 2023 at 10:01):Ah... let me check if I'm able to log into the old site...
Oliver Bertuch (Sep 20 2023 at 10:02):Looks like we could get the data from https://web.archive.org/web/20221128194851/https://dataversecommunity.global
Philipp Conzett (Sep 20 2023 at 10:02):no... "This site has been shutdown" :(
Philipp Conzett (Sep 20 2023 at 10:03):ok, I'm scrolling to latest available snapshot...
Philipp Conzett (Sep 20 2023 at 10:04):seems to be Feb 10?
Oliver Bertuch (Sep 20 2023 at 10:04):Do you want a copy of the old design or would it be an option to go with sth new?
Philipp Conzett (Sep 20 2023 at 10:05):Sth new please!
Oliver Bertuch (Sep 20 2023 at 10:05):For the working groups we copied parts of the design. Not sure the menus etc will work
Oliver Bertuch (Sep 20 2023 at 10:05):So please choose a theme :smile:
Oliver Bertuch (Sep 20 2023 at 10:05):Either pick one of those: https://pages.github.com/themes/
Oliver Bertuch (Sep 20 2023 at 10:06):(Those are the least work)
Oliver Bertuch (Sep 20 2023 at 10:06):Or we can go with a different theme. Will require to setup a pipeline, but totally doable
Oliver Bertuch (Sep 20 2023 at 10:07):There are plenty of pages with Jekyll themes. Here'S a list: https://jekyllrb.com/docs/themes/
Philipp Conzett (Sep 20 2023 at 10:11):Hm... maybe https://pages-themes.github.io/architect/
Philipp Conzett (Sep 20 2023 at 10:11):Will it be possible to have tabs / different pages?
Oliver Bertuch (Sep 20 2023 at 10:12):Sure! But that depends on the theme. To give you an example of a page hosted on GH pages which might be closer to what y'all look for: https://www.helmholtz-hirse.de/ (coming from https://github.com/Helmholtz-HiRSE/helmholtz-hirse.github.io)
Philipp Conzett (Sep 20 2023 at 10:12):like one tab for About one for Members one for Working Groups etc?
Philipp Conzett (Sep 20 2023 at 10:13):Yes, that looks more like the old GDCC homepage. Does it need a lot of twirking?
Oliver Bertuch (Sep 20 2023 at 10:16):We would need to adapt the CSS etc
Oliver Bertuch (Sep 20 2023 at 10:16):We probably wouldn't want it to look like HiRSE :wink:
Oliver Bertuch (Sep 20 2023 at 10:17):Also: if you don't like Jekyll (it can be tedious to learn just another thing), we can use Sphinx, too
Oliver Bertuch (Sep 20 2023 at 10:17):The Dataverse guides are written using Sphinx
Philipp Conzett (Sep 20 2023 at 10:17):OK, I'd prefer a page that is easy to update :)
Philipp Conzett (Sep 20 2023 at 10:18):Will it be done by writing markdown in GitHub?
Oliver Bertuch (Sep 20 2023 at 10:18):https://project.software-metadata.pub/ is an example I created with Sphinx + the book theme. https://sphinx-book-theme.readthedocs.io/en/latest/index.html#
Oliver Bertuch (Sep 20 2023 at 10:18):Jekyll is mostly Markdown, yes
Oliver Bertuch (Sep 20 2023 at 10:19):(Sphinx can be used with Markdown as well, not just reStructuredText as we do in the main guides)
Philipp Conzett (Sep 20 2023 at 10:19):https://project.software-metadata.pub/ looks nice!
Philipp Conzett (Sep 20 2023 at 10:20):Should we just go for the Hermes-type?
Oliver Bertuch (Sep 20 2023 at 10:21):I don't know what y'all like :smile_cat:
Philipp Conzett (Sep 20 2023 at 10:22):To me, it looks fine. Will it be possible to use the old alias = https://dataversecommunity.global/ ?
Oliver Bertuch (Sep 20 2023 at 10:22):Jekyll is pretty neat when it comes to including stuff. The list of partners, allies and codes on the HiRSE page for example are simply a bunch of text files where a loop is applying the template
Oliver Bertuch (Sep 20 2023 at 10:22):Sphinx needs more stuff explicitly written out - not really easy going to create custom templates
Oliver Bertuch (Sep 20 2023 at 10:23):Philipp Conzett said:
Will it be possible to use the old alias = https://dataversecommunity.global/ ?
Absolutely - we can switch the CNAME when the new page is done. Does that sound alright? (Also gives us time to find out who runs the show for that domain...)
Philipp Conzett (Sep 20 2023 at 10:25):So, you'd recommend Jekyll for a more easily maintained site?
Oliver Bertuch (Sep 20 2023 at 10:25):It's hard to say. It really depends on the people doing the maintenance
Oliver Bertuch (Sep 20 2023 at 10:26):If you already contributed to the Dataverse guides, you might like the experience there
Philipp Conzett (Sep 20 2023 at 10:26):I guess it'll be Jim, me, Julian...
Philipp Conzett (Sep 20 2023 at 10:27):Did you say the IQSS Dataverse Guides are based on Jekyll?
Oliver Bertuch (Sep 20 2023 at 10:27):If you want an experience closer to the main guides, maybe https://sphinx-themes.readthedocs.io/en/latest/sample-sites/sphinx-bootstrap-theme/ is the way to go?
Oliver Bertuch (Sep 20 2023 at 10:27):No, the DV guides are Sphinx
Oliver Bertuch (Sep 20 2023 at 10:28):Here are many more Sphinx themes: https://sphinx-themes.readthedocs.io/en/latest/
Philipp Conzett (Sep 20 2023 at 10:30):OK, let's go for Sphinx. It'll look like https://guides.dataverse.org/en/latest/?
Oliver Bertuch (Sep 20 2023 at 10:30):Only if we make it that way!
Oliver Bertuch (Sep 20 2023 at 10:30):It's a theme...
Oliver Bertuch (Sep 20 2023 at 10:30):IQSS added the sidebar, too.
Philipp Conzett (Sep 20 2023 at 10:32):Are there any pre-defined themes for Sphinx?
Oliver Bertuch (Sep 20 2023 at 10:33):No, not really. There are some well known ones, but it needs a config anyway. But not to worry, this is really easy to do. Just pick sth you like from https://sphinx-themes.readthedocs.io/en/latest/
Oliver Bertuch (Sep 20 2023 at 10:35):I went ahead and created https://github.com/gdcc/dataversecommunity.global as a starting point
Philipp Conzett (Sep 20 2023 at 10:41):Thanks, Ok, these are my favorites:
Which one do you think is the most sustainable one? :)
Oliver Bertuch (Sep 20 2023 at 10:43):Well readthedocs and it's derivates are well maintained. But I'm not sure I'd call them "good looking" for a business like website
Oliver Bertuch (Sep 20 2023 at 10:44):Here's what this looks like in a larger documentation: https://docs.nextcloud.com/server/latest/user_manual/en/files/index.html
Philipp Conzett (Sep 20 2023 at 10:51):Hm... I see, but I think a simple page without many scrolling and stuff would be good. The only thing I miss is a banner on top. Do the readthedocs allow a banner like we had on the old page?
Oliver Bertuch (Sep 20 2023 at 10:53):Nope
Philipp Conzett (Sep 20 2023 at 11:06):I see that almost none of the themes do... Do you have a suggestion? Does the Book theme work well for Hermes?
Oliver Bertuch (Sep 20 2023 at 11:10):Yes, it does work well for us.
Oliver Bertuch (Sep 20 2023 at 11:11):I put a workflow in place we can adapt once we have some content and pointed https://www.gdcc.io to the pages deployment for now.
Philipp Conzett (Sep 20 2023 at 11:16):Ok, so gdcc.io will be our new address?
Philip Durbin 🚀 (Sep 20 2023 at 11:16):Just to be 100% clear, with the Dataverse guides we have to write in reStructuredText (.rst) rather than Markdown (.md). This, to me, is the biggest downside of Sphinx, but otherwise it's fine. It does a good job for docs.
Philipp Conzett (Sep 20 2023 at 11:34):@Oliver Bertuch please let me know if you need more input :)
Oliver Bertuch (Sep 20 2023 at 11:42):No one has to write Sphinx docs in RST. This is a self inflicted limitation.
Philip Durbin 🚀 (Sep 20 2023 at 11:50):oh?
Philip Durbin 🚀 (Sep 20 2023 at 11:50):maybe years ago this was true
Oliver Bertuch (Sep 20 2023 at 11:52):https://myst-parser.readthedocs.io/en/latest/index.html
Philip Durbin 🚀 (Sep 22 2023 at 11:22):What about Docusaurus? I haven't played with it myself but there's some chatter about it in #8905.
Thomas van Erven (Sep 22 2023 at 11:27):Most of DANS's stuff (internal at least) is running with mkdocs (markdown, naturally). I built a small scaffold with https://squidfunk.github.io/mkdocs-material/getting-started/ in glorious Docker because I'm a fancy bear like that.
Thomas van Erven (Sep 22 2023 at 11:28):(I like Material, hence my choice for extra dependencies :) )
Philip Durbin 🚀 (Sep 22 2023 at 11:33):looks nice
Philip Durbin 🚀 (Sep 22 2023 at 13:25):I just attempted to summarize the tools so far at https://github.com/IQSS/dataverse-frontend/issues/26 because we're in the market for a tool like Sphinx or Jekyll or whatever for the guides for the new frontend.
Philip Durbin 🚀 (Sep 22 2023 at 20:09):Philipp Conzett said:
Hm... I see, but I think a simple page without many scrolling and stuff would be good. The only thing I miss is a banner on top. Do the readthedocs allow a banner like we had on the old page?
The pydata theme can have a banner on top. It's used by https://docs.jupyter.org which looks like this:
Screen-Shot-2023-09-22-at-4.09.22-PM.png
Philip Durbin 🚀 (Sep 22 2023 at 20:17):I just pushed a proof of concept for GDCC to a branch at https://github.com/gdcc/dataversecommunity.global/tree/sphinx-markdown
Here's a screenshot:
Screenshot-2023-09-22-at-16-16-01-The-Global-Dataverse-Community-Consortium-GDCC-documentation.png
Philipp Conzett (Sep 25 2023 at 12:04):Thanks for moving this forward, @Oliver Bertuch + @Philip Durbin! I've put this on the agenda for the GDCC steering committee meeting tomorrow. From the discussion above, I'm not sure whether we/you have decided on which framework/theme to use. Will it be difficult to migrate from one framework/theme to another if we at a later stage find out that this would be necessary/desirable? I think the most important thing right now is to get up and running a working GDCC website.
Philipp Conzett (Sep 25 2023 at 12:08):.... ah, on the GitHub page URL I see it says sphinx-markdown, so I guess that's the framework/theme we're working on right now? :-)
Philipp Conzett (Sep 25 2023 at 12:11):Question: Does sphinx-markdown somehow support to have a blog page / a page with news items? That's actually something we need.
Philip Durbin 🚀 (Sep 25 2023 at 12:33):I'm not trying to make a decision. I was just trying to get Sphinx to use Markdown. :grinning:
I called the branch sphinx-markdown but the extension that supports Markdown (that I added to that branch) is called MyST: https://www.sphinx-doc.org/en/master/usage/markdown.html#markdown
Philipp Conzett (Sep 25 2023 at 12:48):Thanks! Do you need any input from me? I guess if you show me how to migrate / add new text, I can help migrate from the old website. When the site is ready, what will be the URL? @Oliver Bertuch mentioned https://www.gdcc.io, which I think would be nice. Who do we need to ask to redirect from https://dataversecommunity.global/?
Philipp Conzett (Sep 25 2023 at 12:48):Can we invite Jim to Zulip? :-)
Philip Durbin 🚀 (Sep 25 2023 at 12:49):Sure, go for it!
Philip Durbin 🚀 (Sep 25 2023 at 12:50):To try adding content, can you please try following the steps at https://github.com/gdcc/dataversecommunity.global/blob/sphinx-markdown/README.md ?
Philipp Conzett (Sep 25 2023 at 12:57):Sorry, I'm not sure whether I understand the instructions - I've never done this kind of stuff before. Once the different pages we want to add, i.e., About, Members, Working Groups, etc., will there be an easy way to just add text in Markdown and press Update or similar? If you can spare a couple of minutes, it would be great if you could explain on shared screen. Thanks!
Philip Durbin 🚀 (Sep 25 2023 at 13:05):A screenshare is a great idea. Do you have time now? https://harvard.zoom.us/j/95067267479?pwd=QzB3TWtZRVlYVGpMRkN2Wk0yLzJsUT09
Oliver Bertuch (Sep 25 2023 at 13:20):Y'all still going?
Philip Durbin 🚀 (Sep 25 2023 at 13:22):Haven't started and I need to bike to work (in the rain). :bike: :rainy:
Philipp Conzett (Sep 25 2023 at 13:22):Great, thanks @Philip Durbin Can meet in about 8 min. = at 13:30 UTC?
Philip Durbin 🚀 (Sep 25 2023 at 13:22):Sure, I can hang out for 8 minutes :grinning:
Oliver Bertuch (Sep 25 2023 at 13:22):Happy to join y'all
Philipp Conzett (Sep 25 2023 at 13:24):See on Zoom (see above) in 6 minutes :)
Oliver Bertuch (Sep 25 2023 at 14:05):@Philip Durbin you mind me pushing into your branch directly?
Philip Durbin 🚀 (Sep 25 2023 at 14:33):Nope! Go for it!
Oliver Bertuch (Sep 25 2023 at 15:37): Philipp Conzett (Sep 25 2023 at 15:43):Great job! :+1:
Philip Durbin 🚀 (Sep 25 2023 at 15:44):Yes! Fantastic!
Philip Durbin 🚀 (Sep 25 2023 at 15:45):Out of curiosity, do we want just https://gdcc.io to work too? It's shorter. :thinking:
Oliver Bertuch (Sep 25 2023 at 15:56):Right now, that is a redirect to dataversecommunity.global...
Oliver Bertuch (Sep 25 2023 at 15:57):I would like to leave that intact while we are working on the page
Oliver Bertuch (Sep 25 2023 at 15:57):Hope that makes sense...
Oliver Bertuch (Sep 25 2023 at 15:58):I updated https://github.com/gdcc/dataversecommunity.global/tree/sphinx-markdown with a more detailed README on how to build the page locally
Oliver Bertuch (Sep 25 2023 at 15:58):Hope it helps
Oliver Bertuch (Sep 25 2023 at 15:58):There's still work ahead - we need to add all the nice opengraph stuff, logos etc
Oliver Bertuch (Sep 25 2023 at 15:58):But the "bones" are there, as you said @Philipp Conzett
Philip Durbin 🚀 (Sep 25 2023 at 15:59):The README looks great (though I'll need to learn poetry! :sweat_smile: ).
Oliver Bertuch (Sep 25 2023 at 15:59):Poetry is really simple
Oliver Bertuch (Sep 25 2023 at 15:59):It does all the venv shenanigans for you
Philip Durbin 🚀 (Sep 25 2023 at 16:00):http://gdcc.io (no s) does redirect, like you said. https://gdcc.io (with s) times out. This all fine for now, until we finalize the site.
Oliver Bertuch (Sep 25 2023 at 16:01):@Philip Durbin do you think the working groups should be re-united under the main webpage instead of distinct pages? We could do redirects to keep the nice shortlinks around
Philip Durbin 🚀 (Sep 25 2023 at 16:02):I could go either way. Maybe the current independence is better.
Philip Durbin 🚀 (Sep 25 2023 at 16:02):Decoupled, if you will. :grinning:
Oliver Bertuch (Sep 25 2023 at 16:03):Yeah. But maybe we should switch to a different layout once we're done with the main page. So it looks more consistent
Oliver Bertuch (Sep 25 2023 at 16:03):And we could create a template repo for future working groups, too
Philip Durbin 🚀 (Sep 25 2023 at 16:04):I like the PyData theme better than what we have for ct.gdcc.io
Philip Durbin 🚀 (Sep 25 2023 at 16:05):One thing at time, I guess. :grinning:
Philip Durbin 🚀 (Sep 25 2023 at 16:05):How do you feel about setting up previews for PRs, like we have for the guides?
Oliver Bertuch (Sep 25 2023 at 16:06):That's actually non-trivial
Philipp Conzett (Sep 25 2023 at 16:06):https://gdcc.io would be great!
Oliver Bertuch (Sep 25 2023 at 16:07):@Philipp Conzett I can change that right away if you want me to. If you rather want to leave the redirect intact for now, let me know.
Oliver Bertuch (Sep 25 2023 at 16:08):@Philip Durbin the only way I can think of how we can pull that off would be by using readthedocs. I can't think of a way to do this with GH pages only.
Philipp Conzett (Sep 25 2023 at 16:08):@Oliver Bertuch Can we have both? gdcc.io as the main address, but also redirect from https://dataversecommunity.global/ ?
Oliver Bertuch (Sep 25 2023 at 16:08):Philipp Conzett said:
Can we have both? gdcc.io as the main address, but also redirect from https://dataversecommunity.global/ ?
I'm not sure I follow....
Oliver Bertuch (Sep 25 2023 at 16:09):Do you want to reverse the redirects?
Oliver Bertuch (Sep 25 2023 at 16:09):So dataversecommunity.global redirects to gdcc.io?
Philipp Conzett (Sep 25 2023 at 16:13):Yes, please :)
Oliver Bertuch (Sep 25 2023 at 16:15):OK then someone who has access to that domain has to check if that is actually possible at their place....
Philipp Conzett (Sep 25 2023 at 16:16):Ah, ok, I guess that would be someone at IQSS, @Philip Durbin ?
Philip Durbin 🚀 (Sep 25 2023 at 16:20):No, probably Don (but he's on vacation) or Jon.
Philipp Conzett (Sep 28 2023 at 03:47):@Oliver Bertuch, @Philip Durbin Short heads-up: We discussed this on the GDCC steering committee call on Tuesday and everyone was happy with the new website. :+1: Please let me know when the different pages are ready to be filled with content. Thanks!
Philipp Conzett (Sep 28 2023 at 05:52):@Oliver Bertuch @Philip Durbin The sign-up page currently uses two PDFs. Jon would like these to be changed into sign-up web forms. I guess the idea is that instead of printing and filling out the PDF, an organization should be able to fill in a web form and GDCC/the guys at UNC will be notified so we/they can follow up. I see that the current PDF files are signed. I'm not sure how this can be done in a web form or if it is necessary at all.
Philip Durbin 🚀 (Sep 28 2023 at 11:00):I went to add more page stubs but now the site uses poetry and I'm having trouble installing it on my Mac. @Oliver Bertuch can you help over in #python > install poetry fail on Mac ? Or can you stub out the pages?
Philip Durbin 🚀 (Sep 28 2023 at 11:00):@Philipp Conzett for the form, you have a tool you like for this, right? Lime Survey or something?
Philip Durbin 🚀 (Sep 28 2023 at 11:23):Also, @Oliver Bertuch is Python 3.10 a hard requirement? I'm on 3.9.6.
Philip Durbin 🚀 (Sep 28 2023 at 11:24):I'm starting to worry it's going to be too hard for people to contribute. :grimacing:
Oliver Bertuch (Sep 28 2023 at 11:33):Sphinx is currently Python 3.9+, so we can downgrade that
Oliver Bertuch (Sep 28 2023 at 11:44):I just downgraded and pushed
Oliver Bertuch (Sep 28 2023 at 11:47):@Philip Durbin I can recommend using https://github.com/pyenv/pyenv or ASDF to manage multiple installations of Python BTW :wink:
Philip Durbin 🚀 (Sep 28 2023 at 12:07):I'm thinking about non-developers.
Philip Durbin 🚀 (Sep 28 2023 at 12:08):poetry run task docs-live works great. Thanks!
Philip Durbin 🚀 (Sep 28 2023 at 14:55):Uh-oh, the old site is under maintance.
Screen-Shot-2023-09-28-at-10.54.31-AM.png
Philip Durbin 🚀 (Sep 28 2023 at 14:55):@Philipp Conzett do you just want to tell me which Markdown files to create? news.md? What else?
Philip Durbin 🚀 (Sep 28 2023 at 16:25):@Philipp Conzett here you go: https://www.gdcc.io
Screen-Shot-2023-09-28-at-12.24.44-PM.png
Philip Durbin 🚀 (Sep 28 2023 at 16:26):To edit the "about" page, for example: https://github.com/gdcc/dataversecommunity.global/blob/sphinx-markdown/source/about.md
Philip Durbin 🚀 (Sep 28 2023 at 16:27):Oh, and I found this, if you want it:
Philipp Conzett (Sep 30 2023 at 16:10):Thanks! Jim has saved content from the old page. I've asked him to help us populate the new site.
Philip Durbin 🚀 (Mar 25 2024 at 13:31):Should we start a new topic for continued maintenance of the GDCC website now that we're on GitHub pages?
Philip Durbin 🚀 (Mar 25 2024 at 13:32):I see at least two potential topics:
Philip Durbin 🚀 (Mar 25 2024 at 13:58):Ok, I created a team called https://github.com/orgs/gdcc/teams/gdcc-website-admin and added @Juan Pablo Tosca Villanueva to it.
Juan Pablo Tosca Villanueva (Mar 25 2024 at 19:15):What is the branch that you are using for this, sphinx-markdown? I can't see anything on main
Philip Durbin 🚀 (Mar 25 2024 at 19:17):yeah, sphinx-markdown
Philip Durbin 🚀 (Apr 17 2024 at 19:21):Oliver Bertuch said:
So dataversecommunity.global redirects to gdcc.io?
Did we ever set up this redirect? I'm asking because @Sonia Barbosa forwarded an email to me (INC05167647) and @Leo Andreev asked at standup.
The first step to to figure out who controls DNS for dataversecommunity.global. Possibly @Don Sizemore ?
Then we should figure out where to host it. I suppose we want to redirect all traffic to the new site, https://www.gdcc.io
Last updated: Nov 01 2025 at 14:11 UTC