Pull Request for Comments to the Syllabus

.github/workflows/pr-preview-surge.yml

@@ -0,0 +1,129 @@
+name: PR Preview (Surge, gated by review)
+
+on:
+  pull_request_target:
+    types: [opened, reopened, synchronize, ready_for_review, edited, labeled]
+  pull_request:
+    types: [closed]  # for teardown
+
+# Token perms needed for commenting + reading artifacts
+permissions:
+  contents: read
+  issues: write
+  pull-requests: write
+
+env:
+  SURGE_DOMAIN_BASE: ${{ github.event.repository.name }}
+  # Adjust if your Docusaurus baseUrl changes (no leading slash, no trailing slash)
+  BASE_PATH: robotframework-RFCP-syllabus
+
+jobs:
+  build:
+    # Build untrusted PR code WITHOUT secrets
+    if: github.event_name == 'pull_request_target' && github.event.pull_request.draft == false
+    name: Build PR
+    runs-on: ubuntu-latest
+    defaults:
+      run:
+        working-directory: ./website
+    steps:
+      - name: Checkout PR head (read-only)
+        uses: actions/checkout@v4
+        with:
+          repository: ${{ github.event.pull_request.head.repo.full_name }}
+          ref: ${{ github.event.pull_request.head.ref }}
+          persist-credentials: false
+          fetch-depth: 0
+
+      - name: Use Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 22
+          cache: yarn
+          cache-dependency-path: website/yarn.lock
+
+      - name: Install deps
+        run: yarn install --frozen-lockfile
+
+      - name: Build
+        run: yarn build
+
+      - name: Upload build artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: pr-build
+          path: website/build
+          if-no-files-found: error
+          retention-days: 5
+
+  deploy:
+    # Pauses at Environment gate until a member approves
+    if: github.event_name == 'pull_request_target' && github.event.pull_request.draft == false
+    name: Deploy Preview to Surge (requires approval)
+    needs: build
+    runs-on: ubuntu-latest
+    environment:
+      name: preview
+      url: ${{ steps.deployed.outputs.preview_url }}
+
+    steps:
+      - name: Download build artifact
+        uses: actions/download-artifact@v4
+        with:
+          name: pr-build
+          path: ./build
+
+      - name: Install Surge CLI
+        run: npm i -g surge
+
+      - name: Compute preview domain + path
+        id: dom
+        run: |
+          echo "domain=${{ env.SURGE_DOMAIN_BASE }}-pr-${{ github.event.number }}.surge.sh" >> $GITHUB_OUTPUT
+          echo "path=/${{ env.BASE_PATH }}/" >> $GITHUB_OUTPUT
+
+      # Stage the Docusaurus output under the baseUrl path (so it serves at /<BASE_PATH>/)
+      - name: Stage site under base path
+        run: |
+          mkdir -p ./staging/${{ env.BASE_PATH }}
+          # Move entire built site into the subpath
+          shopt -s dotglob
+          mv ./build/* ./staging/${{ env.BASE_PATH }}/
+          # Optional: keep a root 200.html/404.html if you want nicer root errors
+          # but not required; we'll serve only from /<BASE_PATH>/
+
+      - name: Deploy to Surge
+        id: deployed
+        env:
+          SURGE_TOKEN: ${{ secrets.SURGE_TOKEN }}   # environment secret on "preview"
+        run: |
+          surge --project ./staging \
+                --domain ${{ steps.dom.outputs.domain }} \
+                --token "$SURGE_TOKEN"
+          echo "preview_url=https://${{ steps.dom.outputs.domain }}${{ steps.dom.outputs.path }}" >> $GITHUB_OUTPUT
+
+      # Comment using a purpose-built action (more robust than raw API for forked PRs)
+      - name: Comment with preview URL
+        uses: peter-evans/create-or-update-comment@v4
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          issue-number: ${{ github.event.number }}
+          body: |
+            🚀 Preview deployed to **${{ steps.deployed.outputs.preview_url }}**
+
+  teardown:
+    if: github.event_name == 'pull_request' && github.event.action == 'closed'
+    name: Teardown Surge preview
+    runs-on: ubuntu-latest
+    steps:
+      - name: Install Surge CLI
+        run: npm i -g surge
+      - name: Compute domain
+        id: dom
+        run: |
+          echo "domain=${{ github.event.repository.name }}-pr-${{ github.event.number }}.surge.sh" >> $GITHUB_OUTPUT
+      - name: Teardown
+        env:
+          SURGE_TOKEN: ${{ secrets.SURGE_TOKEN }}
+        run: |
+          surge teardown "${{ steps.dom.outputs.domain }}" --token "$SURGE_TOKEN" || true

LOs.csv

@@ -1,12 +1,12 @@
 LO ID,K Level,Content,Slide Number,Done,Notes
 LO-1.1,(K1),Recall the two main use cases of Robot Framework,,,
-LO-1.1.1,(K1),recall the test levels Robot Framework is mostly used for,,,
+LO-1.1.1,(K1),Recall the test levels Robot Framework is mostly used for,,,
 LO-1.2.1,(K1),Recall the layers of the Generic Test Automation Architecture (gTAA) and their corresponding components in Robot Framework,,,
 LO-1.2.2,(K1),Recall what is part of Robot Framework and what is not,,,
 LO-1.2.3,(K1),Recall the technology Robot Framework is built on and the prerequisites for running it,,,
 LO-1.3,(K1),Recall the key attributes of the syntax that makes Robot Framework simple and human-readable,,,
 LO-1.3.3,(K2),Explain the difference between User Keywords and Library Keywords,,,
-LO-1.3.4,(K1),Recall the difference between Resource Files and Libraries and their artefacts,,,
+LO-1.3.4,(K1),Recall the difference between Resource Files and Libraries and their artifacts,,,
 LO-1.4,(K1),Recall the three specification styles of Robot Framework,,,
 LO-1.4.1,(K2),Understand the basic concepts of Keyword-Driven Specification,,,
 LO-1.4.2,(K2),Understand the basic concepts of Behavior-Driven Specification,,,

Notes_Tasks.md

@@ -0,0 +1,28 @@
+# Notes or comments
+
+>  Mko13 on Feb 1
+I think, somewhere in Chapter 1, also reporting should be mentioned in very general terms (details are explained in later chapters). Maybe also include an example of a log file.
+
+> Mko13 on Feb 1
+> Overall, the intro sub-section can be restructured a bit, so that first is general definition of what "Specification Style" means, then what styles exist in RF, and then short, generic description of each one.
+>
+> Also, language and grammar could be polished a bit.
+
+
+> kstine on Feb 9 About 2.1.2.1
+> I would have said something else beside locally:
+>
+> This may seem verbose but it is easier to understand:
+> Corresponds to the [<setting>] setting.
+> ALL of the settings should be described as:<br/>
+> `- <setting>` Description
+>
+> With each setting with its own line. i.e. break up the Test Setup / Task Setup from Test Teardown / Task Teardown
+>
+> The user guide lays out these settings very well: https://robotframework.org/robotframework/latest/RobotFrameworkUserGuide.html#setting-section-1
+>
+> A clear list of settings and definitions- very concise and consistent.
+
+> Mko13 on Feb 1 anbout Section 2.1.2.3
+> A table summarizing the sections could be helpful, similar to the one in User Guide.
+