updated README to handle forks

RedHatQuickCourses · Mar 4, 2024 · ec881bc · ec881bc
1 parent 0d532df
commit ec881bc
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 2 deletions.
diff --git a/.github/workflows/pr.yml b/.github/workflows/pr.yml
@@ -45,6 +45,8 @@ jobs:
         run: npm run build
 
       - name: Publish PR preview to GitHub Pages
+        # Do not run if PR is from fork
+        if: ${{ ! github.event.pull_request.head.repo.fork }}
         uses: rossjrw/pr-preview-action@v1
         with:
           source-dir: ./build/site
diff --git a/README.md b/README.md
@@ -33,7 +33,7 @@ To add a new section under a chapter create an entry in the *modules/CHAPTER/nav
 
 ### Steps
 
-1. Clone the course repository.
+1. Clone or fork the course repository.
 ```
     $ git clone git@github.com:RedHatQuickCourses/rhods-deploy.git
 ```
@@ -65,7 +65,7 @@ To add a new section under a chapter create an entry in the *modules/CHAPTER/nav
     $ git push -u origin rsriniva/ch01s01
 ```
 
-7. Create a GitHub pull request (PR) for your changes using the GitHub web UI.
+7. Create a GitHub pull request (PR) for your changes using the GitHub web UI. For forks, create a PR that merges your forked changes into the `main` branch of this repository.
 
 8. Request a review of the PR from your technical peers and/or a member of the PTL team.