Overview of Erik's TLJH maintenance effort #711
Description
Attention spotlight
- Bump to recent versions, and make bootstrap.py update to those when run #719
- Running
pip install oauthenticator==1.*should include the --upgrade flag - right? #732 - Add details to the Enable HTTPS how-to section #726
- JSONSchema validation of our config #725
- Toc shows up twice in howto docs #701
Misc contributions
- Refactor bootstrap/bootstrap.py for readability
- Refactor integration-tests/test_bootstrap.py for readability
- Refresh GitHub workflow files based on insights gained over time
Revision of our GitHub Workflows and README.rst to README.md #710 covers...- Test against Ubuntu 18.04 20.04
- Test against Python 3.6 3.9
- Coalesce the duplicated test logic in integration-test.yml and upgrade-test.yml
- Adds badges to README.md
- Massive efforts to add tests against 21.10
- To pass 21.10 tests, we require a traefik-proxy release also
Release needed to avoid TLJH failure in Ubuntu 21.10 traefik-proxy#136
ci: don't run tests if docs change traefik-proxy#139
ci/docs: install autodocs-traits as a PyPI package & pin sphinx traefik-proxy#138
Add changelog for 0.3.0 traefik-proxy#137
- To pass 21.10 tests, we require a traefik-proxy release also
- ReadTheDocs details
- Get myself added as a RTD maintainer: https://readthedocs.org/projects/the-littlest-jupyterhub/
- Enable RTD docs builds on PRs and preview
- Add modern .readthedocs.yml file
ci: add .readthedocs.yaml #712
- Figure out if the template file is added by mistake in Add instructions to deploy on Azure #342. If so, delete it.
Remove template in root folder - a mistakenly committed file #713 - Update language docs: fix language regarding master #718
- Apply TLJH auth config with less assumptions #721
- Modernize docs Makefile with sphinx-autobuild #741
- docs: fix how-to sections table of content section #742
- docs: require sphinx>=2, otherwise error follows #743
- Update firstuseauthenticator to 1.0.0 #749
- pre-commit
- Submit a PR with small fixes for flake8 etc
Small fixes for flake8 and other smaller pre-commit tools #747 - Submit a PR adding the config
Add .pre-commit-config #748 - Submit a PR making autoformat changes
pre-commit: apply black formatting (and prettier on one yaml file) #755 - Activate pre-commit.ci after merges
- Submit a PR with small fixes for flake8 etc
- Version management
While it is some extra work to do version management, I've found that it can be easier down the line. Having done some version management provides a clear way for documenting development changes that otherwise needs to be documented elsewhere where it will be less findable.
I'd much prefer doing some additional work with managing a changelog and releases than to handle the consequences of not doing so down the line as a maintainer.
PR reviews
- Review Document tljh-config commands by referencing the --help sections #213
I pushed a commit making the PR reasonable to merge in my mind. - Review Exit when tljh-config is called as non-root #232
- Review Few updates from reading through the docs #325
- Review Test TLJH against 19.04 #381
- Review add /opt/tljh/user/bin to PATH #413
I have to delegate this to someone else for now due to a lack of relevant understanding, I tried summarizing the situation though. - Review Add locale and other environment variables support for systemd service jupyterhub #414
- Review Use /health for check_hub_ready #475
- Review run integration tests on latest Ubuntu 19.10 #521
- Review [WIP] Add --no-user-env flag to the installer #528
- Review Pin oauthenticator to 0.10.0 for AWS Cognito in the docs #539
I described an action point for this PR which is stale by the author, and anyone can fix it now. - Review [WIP] Upgrade to ubuntu 20 #635
- Review use Docker Compose for the development environment #649
I suggest we don't accept this PR based on personal opinion. - Review Added instructions for restarting JupyterHub to docs (re: #455) #666
I made some suggestions and then I approved and merged it. - Review [DNM] Build testing image on arm64 #674
- Review Add support for installing TLJH on Arm64 systems and bump traefik (1.7.18 -> 1.7.33) #679
- Review Reflect the fact that AWS free tier is not enough #696
- Review Switch to Mamba #697
- Review Bump notebook from 6.3.0 to 6.4.1 in /tljh #703
- Review Bump nbgitpuller version #704
I pushed a commit making the PR reasonable to merge in my mind.
Processing issues
- Go through all issues
I've processed all issues, starting from the oldest to the newest. My process has been somewhere along the lines of trying to...
- provide an overview of what has been said
- make sure the original post and title reflect the situation well enough for future readers
- suggest a path to resolving the issue by outlining action points
- close it as resolved
- close it as a duplicate
- close it as something we can't/won't address