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

actions to created tagged archives of event resources in separate repo #59

Open
JessicaS11 opened this issue Jan 11, 2022 · 1 comment
Labels
CI/QC Continous Integration and Quality Control

Comments

@JessicaS11
Copy link
Contributor

JessicaS11 commented Jan 11, 2022

In many cases, hackweek events are "repeated" and happen more than once. We need an easy way to archive the materials for a given event while also being able to use the most recent version of the template for future events. Since there's currently no way to update a repo created from a template, we plan to store the archive as a tagged version of the book/website in a separate repo, along the lines of the discussion in #38.

We could require tags/branches to mark older content on the organization.github.io page, which lives in an organization.github.io repo that is updated by the organization/jupyterbook repo (which is in turn templated per-event from the most recent uwhackweek/jupyerbook-template repo (this repo)).

Originally posted by @JessicaS11 in #38 (comment)

UPDATE: see #68. Updates from the template make it easier to reuse the same event repo (without needing to re-customize content). Archiving/tagging and repo size management will still need to be addressed.

@jomey jomey added the CI/QC Continous Integration and Quality Control label Jan 13, 2022
@scottyhq
Copy link
Contributor

Wanted to add some other notes and thoughts on this for future work.

As of Jupyter Book >=0.12.1 you can publish on Read-The-Docs (RTD). There are two reasons this is particularly nice: 1. It's much easier to setup pull request previews (compared to netlify) and 2. You get automatic versioned docs, so could address this issue of switching between versions and re-using the same repository. Here is an example: https://github.com/UW-GDA/jupyterbook

However, RTD does not support hosting pre-built docs (readthedocs/readthedocs.org#1083), and you're therefore much more limited in control over the build process.

Alternatively, you could manage versions through tags and possibly links to different branches and versions in a more manual way. It appears to be possible to include the same RTD version switcher with pydata-sphinx-theme>=0.8 which is used behind the scenes. In particular see pydata/pydata-sphinx-theme#436 and the new documentation https://pydata-sphinx-theme.readthedocs.io/en/latest/user_guide/configuring.html?highlight=version#add-a-dropdown-to-switch-between-docs-versions

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CI/QC Continous Integration and Quality Control
Projects
None yet
Development

No branches or pull requests

3 participants