Copy repository => Include all branches

[MauroLeidi]

What would you like changed/added and why?

1. I would personally change the image (assets/images/github-use-template-step-2.png)
   in the section how to use this template, by setting the option include all branches. Otherwise the copied repo does not have the gh-pages branch, resulting in a failure ( Error: The process '/usr/bin/git' failed with exit code 1) of the GitHub action (

• name: Setup Git & Install dependencies
  run: |
  git config --global user.email "myemail"
  git config --global user.name "my username"
  python -m pip install --upgrade pip
  pip install -r mkdocs/requirements.txt
  • uses: actions/checkout@v2
    with:
    ref: gh-pages
    path: www)

2. (Not super confident about this second point) Even if both branches are included, If the user doesn't change anything the deploy workflow (

• name: Deploy
  run: |
  cd www/
  echo -e "a\n*\nq\n"|git add -i
  git commit -am "auto: deploy new website"
  git push
  )
  fails with error code 403. One solution is to change the "Read and write permissions" in Settings -> Actions -> General -> Workflow permissions. see: https://stackoverflow.com/questions/72851548/permission-denied-to-github-actionsbot. Maybe also this should be mentioned in the how to use guidelines.

Do you have any interest in helping improve the documentation?

Yes

Do you have any suggestions for the new documents?

No response