Skip to content

Commit

Permalink
gitlab outage fix
Browse files Browse the repository at this point in the history
  • Loading branch information
rlanzafame committed Dec 14, 2024
1 parent 43b0349 commit 9e6ef95
Show file tree
Hide file tree
Showing 3 changed files with 56 additions and 4 deletions.
5 changes: 4 additions & 1 deletion book/_toc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,10 @@ parts:
chapters:
- file: some_content/overview.md
sections:
- file: some_content/text_and_code.ipynb
# DEC 14, 2024: REINSTATE THE COMMENTED PAGE ONCE GITLAB.TUDELFT.NL IS BACK ONLINE
# - file: some_content/text_and_code.ipynb
- file: some_content/text_and_code_gitlab_down.ipynb
# END OF DEC 14, 2024 OUTAGE COMMENT
- file: exercises/exercises
sections:
- file: exercises/001.md
Expand Down
47 changes: 47 additions & 0 deletions book/some_content/text_and_code_gitlab_down.ipynb
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
{
"cells": [
{
"cell_type": "markdown",
"metadata": {},
"source": [
"# Text and code\n",
"\n",
"```{error}\n",
"The interactive Python feature has been temporarily removed from the TeachBooks Template Book because of a system outage at TU Delft's GitLab repository.\n",
"\n",
"This outage affects: 1) new books that are created from the TeachBooks Template, and 2) exising books that are _modified_ while TU Delft GitLab is down.\n",
"\n",
"To see what this page would look like when there is _not_ an outage, you can [visit this book which was created beforehand](https://rlanzafame.github.io/my-first-book/main/some_content/text_and_code.html).\n",
"\n",
"**Did you make a book using this template while the website was down?**\n",
"\n",
"Check whether TU Delft GitLab is live again by visiting [this link](https://gitlab.tudelft.nl/). If it is, you can restore the interactive Python feature to your book by following the one of the two approaches below.\n",
"\n",
"- **Option 1:** Create a new book using the template, following the instructions at [github.com/teachbooks/template](https://github.com/teachbooks/template).\n",
"- **Option 2:** Replace this page in the table of contents file (`_toc.yml`) with the file `text_and_code.ipynb`, then uncomment the lines in the config file (`_config.yml`) that are related to the interactive Python feature. Commit the changes in the GitHub repository of your book, and the GitHub Actions workflow should take care of the rest!\n",
"```"
]
}
],
"metadata": {
"kernelspec": {
"display_name": "base",
"language": "python",
"name": "python3"
},
"language_info": {
"codemirror_mode": {
"name": "ipython",
"version": 3
},
"file_extension": ".py",
"mimetype": "text/x-python",
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.9.18"
}
},
"nbformat": 4,
"nbformat_minor": 2
}
8 changes: 5 additions & 3 deletions requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ jupyterbook-patches
sphinx-image-inverter
download_link_replacer

# now list the packages (and the respective url) you wish to download from the GitLab package registry
--extra-index-url https://gitlab.tudelft.nl/api/v4/projects/11239/packages/pypi/simple
sphinx-thebe ~= 0.9.9
# DEC 14, 2024: THESE LINES ARE TEMPORARILY TAKEN OUT BECAUSE GITLAB.TUDELFT.NL IS DOWN
# # now list the packages (and the respective url) you wish to download from the GitLab package registry
# --extra-index-url https://gitlab.tudelft.nl/api/v4/projects/11239/packages/pypi/simple
# sphinx-thebe ~= 0.9.9
# END PART REMOVED DEC 14, 2024

0 comments on commit 9e6ef95

Please sign in to comment.