Add step names to pr-preview workflow. Make names and run-names more descriptive.

Author: lyulka

.github/workflows/deploy.yml

@@ -1,6 +1,5 @@
-name: Documentation Deployment
-
-run-name: Deploying to GitHub Pages
+name: "Deploy `main` branch to GitHub Pages"
+run-name: "Deploy `main` (sha: ${{ github.sha }}) to Pages"
 
 on:
   push:
@@ -12,12 +11,13 @@ permissions:
 
 jobs:
   deploy:
+    name: 
     runs-on: ubuntu-latest
     steps:
       - name: Checkout main branch 
         uses: actions/checkout@v2
 
-      - name: Installing Python
+      - name: Install Python
         uses: actions/setup-python@v2
         with:
           # actions/setup-python recommends that python-version be fixed so that workflow runs are more 
@@ -37,5 +37,5 @@ jobs:
         run: pip install mkdocs-material
 
       # This step force-pushes the docs to the "gh-pages" branch of the parallelchain-docs repo.
-      - name: Build and deploy mkdocs
+      - name: Build and deploy documentation
         run: mkdocs gh-deploy --force

.github/workflows/pr-preview.yml

@@ -1,4 +1,5 @@
-name: 🚀 Preview
+name: Deploy PR preview to GitHub Pages
+run-name: "Deploy preview for PR #${{ github.event.pull_request.number }}"
 
 concurrency: preview-${{ github.ref }}
 
@@ -17,25 +18,31 @@ permissions:
 
 jobs:
   preview:
-    name: 🚀 Preview
+    name: 
     runs-on: ubuntu-latest
     steps:
-      - name: 🛑 Cancel Previous Runs
+      - name: Cancel previous runs
         uses: styfle/[email protected]
 
-      - name: ⬇️ Checkout
+      - name: Checkout PR source branch
         uses: actions/checkout@v3
 
-      - name: 🐍 Python
+      - name: Install Python
         uses: actions/setup-python@v4
 
-      - name: 🎈 Install and Build
-        run: |
-          pip install --upgrade pip
-          pip install mkdocs pymdown-extensions mkdocs-material
-          mkdocs build
+      - name: Install mkdocs
+        run: pip install mkdocs
 
-      - name: 🚀 Deploy
+      - name: Install pymdown-extensions
+        run: pip install pymdown-extensions
+
+      - name: Install mkdocs-material
+        run: pip install mkdocs-material
+
+      - name: Build documentation 
+        run: mkdocs build
+
+      - name: Deploy generated documentation 
         uses: rossjrw/pr-preview-action@v1
         with:
           source-dir: ./site/