@@ -22,27 +22,29 @@ like for example the historical version of this project may be still found at
2222
2323however this no longer seems to be an option with jb2 so we're going for github pages and github actions
2424
25- ## naming scheme
25+ ## naming scheme: info-mines.paris
2626
27- the result gets published under a URL like ` https://the-orga.github.io/the-repo/ `
28- like .e.g this one is on
29- https://flotpython.github.io/jupyterlab-examples/
27+ we now host almost all courses under a unique domain ` info-mines.paris `
28+ even ` python ` , ` numerique-exos ` and ` python-exos ` that are hosted under the ` flotpython ` github organization
3029
31- ## the action file
30+ one exception though (for now at least)
31+ this very jupyterlab-examples project for now is still under ` github.io ` at
32+ https://flotpython.github.io/jupyterlab-examples/
3233
33- normally all project could share the same action file, that we have named ` myst-topages.yml `
34- note that projects based on astro will use instead ` astro-to-pages.yml `
34+ ## the gh action file
3535
36+ normally all project could share the same action file
3637this file is part of the ones monitored by the ` commons ` tool, that helps us keep common files in sync across projects
3738
38- ### how to set it up
39+ (this of course does not apply to ` intro ` which is based on astro/starlight)
40+
41+ ## how to set it up
3942
4043on a new project, it suffices to
4144
4245- adopt the common action file
4346- and enable Pages at github, see the action file for the details
44-
45- monitor runs under the ` Actions ` tab of the repo
47+ - then monitor successive runs under the ` Actions ` tab of the repo
4648
4749## the caveats
4850
@@ -52,7 +54,10 @@ as compared to the `readthedocs` approach, GH Pages has one major caveat: it
5254does ** not support several branches** to be built and accessible at the same
5355time
5456
55- ### need for a BASE_URL
57+ ### no longer need a BASE_URL
5658
57- given the naming scheme , we need to set a ` BASE_URL ` in the actions file, so that
59+ when hosting under a subpath under ` github.io ` , we needed to set a ` BASE_URL ` in the actions file, so that
5860the generated links are correctly generated under the ` the-repo/ ` folder
61+
62+ this is no longer needed when hosting under a custom domain like
63+ ` info-mines.paris ` , as the landing page is then at the root of the domain
0 commit comments