Added documentation and updated README

Author: drorata

.github/workflows/deploy_pages.yml

@@ -28,6 +28,7 @@ jobs:
       - name: Build and publish
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          # PAT to enable the that happens in the task 'publish_https'
           GIT_PAT: ${{ secrets.MY_PAT }}
         run: |
           pipenv run task publish_https

README.md

@@ -1,13 +1,20 @@
 # Publishing the website:
 
-Three steps:
+Basically, three steps are needed:
 
-1. First, build the site locally:
+1. First, build the site locally
 2. Prepare the static built (use [ghp-import](https://github.com/davisp/ghp-import))
 3. Push to `master`
 
+These steps can be accomplished using:
+
 ```bash
 pelican content -o output -s publishconf.py
 ghp-import output
 git push git@github.com:drorata/drorata.github.io.git gh-pages:master
 ```
+
+For the sake of simplicity and fun, [`Taskfile`](./Taskfile.yaml) is available.
+
+To make things even better, a GitHub Action [`.github/workflows/deploy_pages.yml`](./.github/workflows/deploy_pages.yml) is also there.
+Every push to `source` branch will trigger the building of the site and publishing it.

Taskfile.yaml

@@ -30,6 +30,8 @@ tasks:
       - git push git@github.com:drorata/drorata.github.io.git gh-pages:master
 
   publish_https:
+    # Same as the publish task,
+    # only using HTTPS so the token could be used when GitHub Actions kick in.
     deps: [build]
     cmds:
       - ghp-import output