Create a New Fork#
Create your fork of this repository by clicking on the figure below.
In the Create a new fork pop-up menu, shown in the figure below, deselect the default Copy the main
branch only option.
By doing so, you will reduce further branch creation, required by the workflow.
Note: The key point is to have at least one branch, beside the
gh-pages
, in your fork. This has been tested using both themain
, as well as theside branches
.
In this workflow:
the published website static site content (
jupyter-book build
output) is in thegh-pages
branch,the source code (i.e. Jupyter Book input) is in an arbitrary
branch
defined by the user: any other thangh-pages
,
The arbitrary branch
can be created locally:
git switch -c content_branch
git push origin content_branch
gh-pages
branch will be automatically generated, as defined by thedeploy.yml
workflow, hence its creation is not required.It is not required to have the
gh-pages
locally, once generated by the workflow, as it hosts only the static site build files, which are taken care of by the workflow.
Note: The remote
gh-pages
, itself, hosts the required.html
,.css
,.js
, and the other files, used for generating thehttps://github.com/<your-username>/data-science-for-esm
website.
There is no requirement of having this branch locally.
These will be re-generated, upon a successful workflow execution, every time git push
is performed, in the prior specified git branch. Branch specification is provided in Deploy Settings.