diff --git a/README.md b/README.md index e247f4c..a67a4ec 100644 --- a/README.md +++ b/README.md @@ -11,17 +11,17 @@ The template allows you to start your own Jupyter Book and hosting that book onl ![create_new_repository](figures/create_new_repository.png) -3. Set source for GitHub pages to under `Settings` - `Pages` - `Build and deployment` - `Source` - `GitHub Actions`: ![Activate pages](figures/set_up_pages.png) -4. Make an edit to the book by editing one of the files in the `book/` subdirectory (available under `Code`) or by running the workflow from `Actions` - `All workflows` - `call-deploy-book` - `Run workflow` - `Run workflow`. Wait a few minutes for the website to be deployed, if you're curious, you can see the progress and result under `Actions` - `All workflows` - `call-deploy-book` -`` (The first commit might have failed because github pages wasn't activated at the time of `Initial commit`): +4. Make an edit to the book by editing and committing changes to one of the files in the `book/` subdirectory (available under `Code`). Now checkout the progress of the publishing workflow under `Actions` - `All workflows` - `call-deploy-book` -``. Remember, the first commit which is there has failed because GitHub Pages wasn't activated at the time of `Initial commit`, you could also re-run that job if you don't want to make an edit. You can do so by running the workflow from `Actions` - `All workflows` - `call-deploy-book` - `Initial commit` - `Re-run jobs` - `Re-run all jobs` - `Re-run jobs`: ![Action](figures/action.png) -5. When the workflow has finished, visit your build book at `https://.github.io/` (case sensitive). For our example it is [https://dummydocent.github.io/test_book_from_template/](https://dummydocent.github.io/test_book_from_template/) for the shown repository. These links are visible in the action as well, as shown in the figure above or in the GitHub repository website which you set in step 3. +5. When the workflow has finished, visit your build book at `https://.github.io/` (case sensitive). For our example it is [https://dummydocent.github.io/test_book_from_template/](https://dummydocent.github.io/test_book_from_template/) for the shown repository. These links are visible in the action's summary as well, as shown in the figure of step 4. Additional tip: Set the repository website as your GitHub Pages website under