Skip to content

Commit 2a4384d

Browse files
committed
Add information to unreleased and user doc for upcoming changes which require manual effort during the migration
1 parent 29d6fb5 commit 2a4384d

File tree

2 files changed

+24
-1
lines changed

2 files changed

+24
-1
lines changed

doc/changes/unreleased.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,18 @@
11
# Unreleased
22

3+
## Summary
4+
5+
With #420, any GitHub repos using the PTB for **documentation** will also need to
6+
reconfigure the GitHub Pages settings for each repo:
7+
1. Go to the affected repo's GitHub page
8+
2. Select 'Settings'
9+
3. Scroll down & select 'Pages'
10+
4. Within the 'Build and deployment' section, change 'Source' to 'GitHub Actions'.
11+
12+
This should also create a 'github-pages' environment, if it does not yet exist.
13+
For most repos using the PTB, the updating of the github pages only happens when a
14+
PR is merged to main, so please check post-merge that it worked as expected.
15+
316
## ⚒️ Refactorings
417

518
* [#412](https://github.com/exasol/python-toolbox/issues/392): Refactored pre commit hook package version.py into nox task

doc/user_guide/getting_started.rst

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -179,7 +179,17 @@ forward, and you just can use the example *noxfile.py* below.
179179
180180
.. _toolbox tasks:
181181

182-
7. Go 🥜
182+
7. Setup for deploying documentation (optional)
183+
+++++++++++++++++++++++++++++++++++++++++++++++
184+
Within the `gh-pages.yml`, we use the GitHub `upload-pages-artifact` and `deploy-pages`
185+
actions. In order to properly deploy your pages, you'll need to reconfigure the GitHub
186+
Pages settings for the repo:
187+
1. Go to the affected repo's GitHub page
188+
2. Select 'Settings'
189+
3. Scroll down & select 'Pages'
190+
4. Within the 'Build and deployment' section, change 'Source' to 'GitHub Actions'.
191+
192+
8. Go 🥜
183193
+++++++++++++
184194
You are ready to use the toolbox. With *nox -l* you can list all available tasks.
185195

0 commit comments

Comments
 (0)