📝 README - fixed broken link (#1420)

* fixed broken link * Replace staging URL with Deployment URL * Update README.md * Update README.md --------- Co-authored-by: Tiago Araújo [SSW] <tiagov8@gmail.com>
SSWConsulting · Sep 18, 2024 · bb48d20 · bb48d20
1 parent 87fa1b1
commit bb48d20
Showing 1 changed file with 20 additions and 23 deletions.
diff --git a/README.md b/README.md
@@ -2,13 +2,9 @@
 
 [![Gitmoji](https://img.shields.io/badge/gitmoji-%20😜%20😍-FFDD67.svg?style=flat-square)](https://gitmoji.dev) [![Scheduled CodeAuditor test](https://github.com/SSWConsulting/SSW.Rules/actions/workflows/codeauditor-test.yml/badge.svg?event=schedule)](https://github.com/SSWConsulting/SSW.Rules/actions/workflows/codeauditor-test.yml)
 
-
-v2 of the Rules.
-
 This is a Gatsby generated site pulling data from:
 - [SSW Rules Content Repo 📜](https://github.com/SSWConsulting/SSW.Rules.Content)
 
-
 ## Getting Started
 
 ### Required Tools
@@ -20,18 +16,17 @@ This is a Gatsby generated site pulling data from:
 - Run `yarn install` to install packages
 - Create environment files (.env.development) based off `.env.template` - get the values from Keeper (SSW.Rules Environment Variables)
 
-> **Note**  
-> If you don't work at SSW or can't get on to the SSW.Rules team you can just add values to GITHUB_API_PAT and CONTENT_BRANCH  
-> For `GITHUB_API_PAT`, create a [PAT on GitHub](https://docs.github.com/en/enterprise-server@3.4/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token) (remove angle brackets <>)  
-> Set `CONTENT_BRANCH` to `sample-content-with-guid` (its a smaller version of the main content branch which will build much quicker 🙂)
-> Sometimes you might want to use `main` or create your own branch if you are testing something.
-
+> **Notes:**  
+> * If you don't work at SSW or can't get on to the SSW.Rules team you can just add values to GITHUB_API_PAT and CONTENT_BRANCH  
+> * For `GITHUB_API_PAT`, create a [PAT on GitHub](https://docs.github.com/en/enterprise-server@3.4/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token) (remove angle brackets <>)  
+> * Set `CONTENT_BRANCH` to `sample-content-with-guid` (it's a smaller version of the main content branch which will build much quicker 🙂)
+> * Sometimes you might want to use `main` or create your own branch if you are testing something.
 
 ### Development
 1. Branch off main for your PBI
 2. Install the recommended extensions if using VS Code
 3. Do your work
-4. Run the site in development mode by `yarn dev` (.env.development is required for this step) it takes a while to build all the rules
+4. Run the site in development mode by `yarn dev` (.env.development is required for this step) it takes a while to build all the rules    
    If you have issues, run `yarn clean` then `yarn dev`
 5. Commit code and push
 6. Raise a PR
@@ -49,7 +44,7 @@ This is a Gatsby generated site pulling data from:
 - Pushed to Production.
 - Use @Mention (**OR** Send email) to notify Product Owner/PBI stakeholder that PBI is done (be sure to include screenshots/done video as proof) 
 
-> <As per rule: [Done - Do you go beyond 'Done' and follow a 'Definition of Done'](https://rules.ssw.com.au/done-do-you-go-beyond-done-and-follow-a-definition-of-done)?>
+As per rule: [Done - Do you go beyond 'Done' and follow a 'Definition of Done'?](https://www.ssw.com.au/rules/done-do-you-go-beyond-done-and-follow-a-definition-of-done)
 
 ### Branches
 - Branching strategy is based off [Release Flow](https://docs.microsoft.com/en-us/azure/devops/learn/devops-at-microsoft/release-flow) 
@@ -60,19 +55,18 @@ This is a Gatsby generated site pulling data from:
 
 ### Builds
 - Changes made to http://github.com/SSWConsulting/SSW.Rules.Content (i.e. rule changes) trigger builds that deploy:
-  - **main** to the **staging** site: https://tfs365.com/rules or check the [latest staging workflow](https://github.com/SSWConsulting/SSW.Rules/actions/workflows/build-deploy-staging.yml) for the url
-  - latest **release/xx** to the **production** site: https://www.ssw.com.au/rules
+  - **main** to the **staging** - check the [latest staging workflow](https://github.com/SSWConsulting/SSW.Rules/deployments/staging) for the url
+  - latest **release/xx** to the **production** site - [ssw.com.au/rules](https://www.ssw.com.au/rules)
 
 - Branching off **main** to **release/xx**, or making changes to **release/xx** will build and deploy to the **production** site: https://www.ssw.com.au/rules
 
-
 ### Rules repository
 
 > Rules repository lives here: https://github.com/SSWConsulting/SSW.Rules.Content
 
 Merging changes to **main** on this repo will trigger:
-- a build/release of the **main** branch in Staging [(https://staging.ssw.com.au/rules/)](https://tfs365.com/rules or check the [latest staging workflow](https://github.com/SSWConsulting/SSW.Rules/actions/workflows/build-deploy-staging.yml) for the url).
-- a build/release of the **release** branch Production (https://www.ssw.com.au/rules)
+- a build/release of the **main** branch in Staging - check the [latest staging workflow](https://github.com/SSWConsulting/SSW.Rules/deployments/staging) for the url
+- a build/release of the **release** branch Production - [ssw.com.au/rules](https://www.ssw.com.au/rules)
 
 ### Example Rule
 - An example rule is provided in the repo under `http://localhost:{{ PORT NUMBER }}/rule/`
@@ -82,14 +76,17 @@ Merging changes to **main** on this repo will trigger:
 **Figure: Sample of the Example Rule**
 
 ### Updating and Syncing a Rule from Rules.Content
+
 Sometimes you might have to update a rule markdown file to test your latest feature, such as changing the background color of a greybox.
+
 To update specific markdown components, follow these steps:
+
 1. Access the `sample-content` branch:
-- Visit [SSW.Rules.Content](https://github.com/SSWConsulting/SSW.Rules.Content)
-- Switch to the `sample-content` branch.
+   - Visit [SSW.Rules.Content](https://github.com/SSWConsulting/SSW.Rules.Content)
+   - Switch to the `sample-content` branch
 2. Edit the Rule:
-- Locate the rule you want to modify in the `sample-content` branch.
+   - Locate the rule you want to modify in the `sample-content` branch
 3. Test Your Changes Locally:
-- Open your local instance of SSW.Rules, usually in VS Code.
-- Build the project using the following commands: `yarn clean` and then `yarn dev`
-- Open your local instance in your browser and navigate to the edited rule to see your changes.
+   - Open your local instance of SSW.Rules, usually in VS Code
+   - Build the project using the following commands: `yarn clean` and then `yarn dev`
+   - Open your local instance in your browser and navigate to the edited rule to see your changes