From 6dde91b0dea83c90f815261f3c1010ecf825c628 Mon Sep 17 00:00:00 2001 From: ChloeLin Date: Fri, 9 Feb 2024 14:53:29 +0800 Subject: [PATCH 1/2] fix duplicate name --- ...age001.jpg => bad-azure-resource-screenshot.jpg} | Bin rules/architecture-diagram/rule.md | 2 +- rules/azure-devops-permissions/rule.md | 2 +- .../{image002.png => team-administrator.png} | Bin .../{1.png => folders-in-Hubdoc.png} | Bin .../rule.md | 2 +- rules/do-you-use-gzip/rule.md | 10 +++++----- rules/do-you-use-gzip/{2.png => use-gzip-2.png} | Bin rules/do-you-use-gzip/{3.png => use-gzip-3.png} | Bin rules/do-you-use-gzip/{4.png => use-gzip-4.png} | Bin rules/do-you-use-gzip/{5.png => use-gzip-5.png} | Bin rules/do-you-use-gzip/{6.png => use-gzip-6.png} | Bin rules/do-you-use-gzip/{7.png => use-gzip-7.png} | Bin .../{Picture2.png => lead-magnet.png} | Bin .../rule.md | 2 +- .../{Picture1.png => example-OptinMonster.png} | Bin .../rule.md | 2 +- .../{1.png => compressed-result.png} | Bin rules/do-you-use-pagespeed/rule.md | 2 +- .../{image002.png => ReSharper-green.png} | Bin .../do-you-use-the-best-code-analysis-tools/rule.md | 2 +- .../have-good-lighting-on-your-home-office/rule.md | 2 +- .../{good-example.png => video-background.png} | Bin .../{1.png => example-email-a-link.png} | Bin rules/how-to-install-skypepop/rule.md | 4 ++-- .../{2.png => send-email.png} | Bin .../{Picture1.png => bad-no-hashtag.png} | Bin rules/linkedin-creator-mode/rule.md | 2 +- .../{3.png => install-language-pack.png} | Bin rules/make-sure-all-software-uses-english/rule.md | 2 +- .../{Picture1.png => invoice-receipt-1.png} | Bin .../{Picture4.png => invoice-receipt-4.png} | Bin rules/tax-invoice-vs-eftpos-receipt/rule.md | 4 ++-- ...image001.jpg => bad-unprotected-main-branch.jpg} | Bin rules/use-branch-protection/rule.md | 2 +- rules/website-heatmaps/rule.md | 2 +- .../{Picture3.png => ssw-heatmap.png} | Bin 37 files changed, 21 insertions(+), 21 deletions(-) rename rules/architecture-diagram/{image001.jpg => bad-azure-resource-screenshot.jpg} (100%) rename rules/azure-devops-permissions/{image002.png => team-administrator.png} (100%) rename rules/do-you-know-how-to-enter-a-hubdoc-receipt/{1.png => folders-in-Hubdoc.png} (100%) rename rules/do-you-use-gzip/{2.png => use-gzip-2.png} (100%) rename rules/do-you-use-gzip/{3.png => use-gzip-3.png} (100%) rename rules/do-you-use-gzip/{4.png => use-gzip-4.png} (100%) rename rules/do-you-use-gzip/{5.png => use-gzip-5.png} (100%) rename rules/do-you-use-gzip/{6.png => use-gzip-6.png} (100%) rename rules/do-you-use-gzip/{7.png => use-gzip-7.png} (100%) rename rules/do-you-use-lead-magnets-as-part-of-your-marketing-strategy/{Picture2.png => lead-magnet.png} (100%) rename rules/do-you-use-optinmonster-for-your-content-downloads/{Picture1.png => example-OptinMonster.png} (100%) rename rules/do-you-use-pagespeed/{1.png => compressed-result.png} (100%) rename rules/do-you-use-the-best-code-analysis-tools/{image002.png => ReSharper-green.png} (100%) rename rules/have-good-lighting-on-your-home-office/{good-example.png => video-background.png} (100%) rename rules/how-to-install-skypepop/{1.png => example-email-a-link.png} (100%) rename rules/how-to-install-skypepop/{2.png => send-email.png} (100%) rename rules/linkedin-creator-mode/{Picture1.png => bad-no-hashtag.png} (100%) rename rules/make-sure-all-software-uses-english/{3.png => install-language-pack.png} (100%) rename rules/tax-invoice-vs-eftpos-receipt/{Picture1.png => invoice-receipt-1.png} (100%) rename rules/tax-invoice-vs-eftpos-receipt/{Picture4.png => invoice-receipt-4.png} (100%) rename rules/use-branch-protection/{image001.jpg => bad-unprotected-main-branch.jpg} (100%) rename rules/website-heatmaps/{Picture3.png => ssw-heatmap.png} (100%) diff --git a/rules/architecture-diagram/image001.jpg b/rules/architecture-diagram/bad-azure-resource-screenshot.jpg similarity index 100% rename from rules/architecture-diagram/image001.jpg rename to rules/architecture-diagram/bad-azure-resource-screenshot.jpg diff --git a/rules/architecture-diagram/rule.md b/rules/architecture-diagram/rule.md index 00e752559a1..f47b1a6a1c6 100644 --- a/rules/architecture-diagram/rule.md +++ b/rules/architecture-diagram/rule.md @@ -41,7 +41,7 @@ Check out the [8 Tips to Better Architecture Diagrams](https://adamcogan.com/202 ::: ::: bad img-medium -![Figure: Bad example - A screenshot of the Azure resources used helps, but doesn't show data flows or dependencies](image001.jpg) +![Figure: Bad example - A screenshot of the Azure resources used helps, but doesn't show data flows or dependencies](bad-azure-resource-screenshot.jpg) ::: Depending on the complexity of your solution and your comfort/familiarity with the tools, an architecture diagram could take you anywhere from half an hour to a couple of days. diff --git a/rules/azure-devops-permissions/rule.md b/rules/azure-devops-permissions/rule.md index 7acc4e7183b..16adf037591 100644 --- a/rules/azure-devops-permissions/rule.md +++ b/rules/azure-devops-permissions/rule.md @@ -29,7 +29,7 @@ c. Add users and assign particular permission. 2. You need to be a team admin, in order to add the newly created iteration to the team iterations. -![Figure: Team Administrator - Who have access to iterations in Azure DevOps](image002.png) +![Figure: Team Administrator - Who have access to iterations in Azure DevOps](team-administrator.png) By following this rule and giving people only the specific permissions they need, you can help to ensure that Azure DevOps permissions are set up in a way that maximizes productivity and minimizes the risk of errors or unwanted changes. diff --git a/rules/azure-devops-permissions/image002.png b/rules/azure-devops-permissions/team-administrator.png similarity index 100% rename from rules/azure-devops-permissions/image002.png rename to rules/azure-devops-permissions/team-administrator.png diff --git a/rules/do-you-know-how-to-enter-a-hubdoc-receipt/1.png b/rules/do-you-know-how-to-enter-a-hubdoc-receipt/folders-in-Hubdoc.png similarity index 100% rename from rules/do-you-know-how-to-enter-a-hubdoc-receipt/1.png rename to rules/do-you-know-how-to-enter-a-hubdoc-receipt/folders-in-Hubdoc.png diff --git a/rules/do-you-know-how-to-enter-a-hubdoc-receipt/rule.md b/rules/do-you-know-how-to-enter-a-hubdoc-receipt/rule.md index 2ed093f18cc..12914e171de 100644 --- a/rules/do-you-know-how-to-enter-a-hubdoc-receipt/rule.md +++ b/rules/do-you-know-how-to-enter-a-hubdoc-receipt/rule.md @@ -36,4 +36,4 @@ Depending on the permissions of the User, they can also publish the invoice to X **Tip:** Hubdoc will automatically create folders to categorise the invoices and store for the user. These folders can be reorganised or renamed with ease. We recommend updating the folders early on so the invoices are collated in a useful manner for your business. -![Figure: Email link](1.png) +![Figure: Folders in Hubdoc](folders-in-Hubdoc.png) diff --git a/rules/do-you-use-gzip/rule.md b/rules/do-you-use-gzip/rule.md index 7d2114606e2..9597c9ce9b2 100644 --- a/rules/do-you-use-gzip/rule.md +++ b/rules/do-you-use-gzip/rule.md @@ -25,18 +25,18 @@ For more information about how to use PageSpeed to find which files on your site Use one of the methods described below to add Gzip compression to your site ASP.Net/Angular website * Method 1: Turn on "Dynamic Content Compression" In IIS Server. -![Figure: Choose the website which you want to use Gzip and click on Compression.](2.png) -![Figure: Install "dynamic content compression" if you haven't installed it.](3.png) +![Figure: Choose the website which you want to use Gzip and click on Compression.](use-gzip-2.png) +![Figure: Install "dynamic content compression" if you haven't installed it.](use-gzip-3.png) In **Control Panel** navigate to **All Control Panel Items | Programs and Features**, and click **Turn Windows features on or off**. Choose **Internet Information Services | Web Management Tools | World Wide Web Services | Performance Features | Dynamic Content Compression**. -![Figure : Click "Ok" to install it.](4.png) -![Figure: now enable dynamic content compression for your site.](5.png) +![Figure : Click "Ok" to install it.](use-gzip-4.png) +![Figure: now enable dynamic content compression for your site.](use-gzip-5.png) * Method 2: Using “Gzipper” in your Angular website Follow https://www.npmjs.com/package/gzipper (but it still need IIS Server enable static content compression). Using `npm i gzipper -g` to install "gzipper" first. Add to scripts in your package.json ![](7.png) -![Figure: "Finish configuration like that.](6.png) +![Figure: "Finish configuration like that.](use-gzip-6.png) * Method 3: Using ASP.NET code in MVC Refer to https://www.codeproject.com/Tips/1080065/Improve-the-Performance-of-ASP-NET-MVC-Web-Application. To implement this in ASP.NET MVC, we can utilize `ActionFilterAttribute` and override either `OnActionExecuting` or `OnResultExecuting` method. The below code snippet is being used to check whether the current request browser can accept GZIP/DEFLATE encoding by looking at Accept-Encoding request header. If it finds GZIP encoding in this header, then we would set gzip in Content-encoding in response header and if it supports DEFLATE, then this code would set deflate in Content-encoding. diff --git a/rules/do-you-use-gzip/2.png b/rules/do-you-use-gzip/use-gzip-2.png similarity index 100% rename from rules/do-you-use-gzip/2.png rename to rules/do-you-use-gzip/use-gzip-2.png diff --git a/rules/do-you-use-gzip/3.png b/rules/do-you-use-gzip/use-gzip-3.png similarity index 100% rename from rules/do-you-use-gzip/3.png rename to rules/do-you-use-gzip/use-gzip-3.png diff --git a/rules/do-you-use-gzip/4.png b/rules/do-you-use-gzip/use-gzip-4.png similarity index 100% rename from rules/do-you-use-gzip/4.png rename to rules/do-you-use-gzip/use-gzip-4.png diff --git a/rules/do-you-use-gzip/5.png b/rules/do-you-use-gzip/use-gzip-5.png similarity index 100% rename from rules/do-you-use-gzip/5.png rename to rules/do-you-use-gzip/use-gzip-5.png diff --git a/rules/do-you-use-gzip/6.png b/rules/do-you-use-gzip/use-gzip-6.png similarity index 100% rename from rules/do-you-use-gzip/6.png rename to rules/do-you-use-gzip/use-gzip-6.png diff --git a/rules/do-you-use-gzip/7.png b/rules/do-you-use-gzip/use-gzip-7.png similarity index 100% rename from rules/do-you-use-gzip/7.png rename to rules/do-you-use-gzip/use-gzip-7.png diff --git a/rules/do-you-use-lead-magnets-as-part-of-your-marketing-strategy/Picture2.png b/rules/do-you-use-lead-magnets-as-part-of-your-marketing-strategy/lead-magnet.png similarity index 100% rename from rules/do-you-use-lead-magnets-as-part-of-your-marketing-strategy/Picture2.png rename to rules/do-you-use-lead-magnets-as-part-of-your-marketing-strategy/lead-magnet.png diff --git a/rules/do-you-use-lead-magnets-as-part-of-your-marketing-strategy/rule.md b/rules/do-you-use-lead-magnets-as-part-of-your-marketing-strategy/rule.md index 88fa74f1313..12f0d670905 100644 --- a/rules/do-you-use-lead-magnets-as-part-of-your-marketing-strategy/rule.md +++ b/rules/do-you-use-lead-magnets-as-part-of-your-marketing-strategy/rule.md @@ -31,4 +31,4 @@ A Lead Magnet refers to any content piece; webinar, eBook, infographic, or initi Lead Magnets not only provide a starting place for consumers to solve their initial problem, but also build trust between the consumer and your brand, increasing the likelihood of a return customer, and increasing your potential revenue. -![Figure: Lead Magnet on the SSW site](Picture2.png) +![Figure: Lead Magnet on the SSW site](lead-magnet.png) diff --git a/rules/do-you-use-optinmonster-for-your-content-downloads/Picture1.png b/rules/do-you-use-optinmonster-for-your-content-downloads/example-OptinMonster.png similarity index 100% rename from rules/do-you-use-optinmonster-for-your-content-downloads/Picture1.png rename to rules/do-you-use-optinmonster-for-your-content-downloads/example-OptinMonster.png diff --git a/rules/do-you-use-optinmonster-for-your-content-downloads/rule.md b/rules/do-you-use-optinmonster-for-your-content-downloads/rule.md index dc7ed4f0353..eebbb43eb22 100644 --- a/rules/do-you-use-optinmonster-for-your-content-downloads/rule.md +++ b/rules/do-you-use-optinmonster-for-your-content-downloads/rule.md @@ -22,5 +22,5 @@ The best way to achieve this is to use gated content, which requires potential l At SSW we did some research, and after initially using LeadPages, we decided to swap to OptinMonster. This choice was made for a few reasons, OptinMonster is significantly cheaper than LeadPages, and provides all the features we required including; form builders, pop-up forms, mobile friendly, A/B testing and tracking. -![](Picture1.png) **Figure: Example of OptinMonster pop-up form on [SSWTV](https://tv.ssw.com/) +![](example-OptinMonster.png) **Figure: Example of OptinMonster pop-up form on [SSWTV](https://tv.ssw.com/) ** diff --git a/rules/do-you-use-pagespeed/1.png b/rules/do-you-use-pagespeed/compressed-result.png similarity index 100% rename from rules/do-you-use-pagespeed/1.png rename to rules/do-you-use-pagespeed/compressed-result.png diff --git a/rules/do-you-use-pagespeed/rule.md b/rules/do-you-use-pagespeed/rule.md index 54d71adeefc..6099e3df88b 100644 --- a/rules/do-you-use-pagespeed/rule.md +++ b/rules/do-you-use-pagespeed/rule.md @@ -36,4 +36,4 @@ In Developer Tools (F12), you will have a new tab named PageSpeed. The result of the analysis will be displayed in the PageSpeed tab. -![Figure: Some files can be compressed more than 80%](1.png) +![Figure: Some files can be compressed more than 80%](compressed-result.png) diff --git a/rules/do-you-use-the-best-code-analysis-tools/image002.png b/rules/do-you-use-the-best-code-analysis-tools/ReSharper-green.png similarity index 100% rename from rules/do-you-use-the-best-code-analysis-tools/image002.png rename to rules/do-you-use-the-best-code-analysis-tools/ReSharper-green.png diff --git a/rules/do-you-use-the-best-code-analysis-tools/rule.md b/rules/do-you-use-the-best-code-analysis-tools/rule.md index d398331c0fe..c7a3b71ad33 100644 --- a/rules/do-you-use-the-best-code-analysis-tools/rule.md +++ b/rules/do-you-use-the-best-code-analysis-tools/rule.md @@ -41,7 +41,7 @@ Get ReSharper to green on each file you touch. You want the files you work on to ![Figure: ReSharper will show Orange when it detects that there is code that could be improved](48bc81\_image001.png) -![Figure: ReSharper will show green when all code is tidy](image002.png) +![Figure: ReSharper will show green when all code is tidy](ReSharper-green.png) ### Level 2 diff --git a/rules/have-good-lighting-on-your-home-office/rule.md b/rules/have-good-lighting-on-your-home-office/rule.md index f5e0ca70937..a3fb876a4be 100644 --- a/rules/have-good-lighting-on-your-home-office/rule.md +++ b/rules/have-good-lighting-on-your-home-office/rule.md @@ -33,7 +33,7 @@ Here are some tips: ::: ::: good -![Figure: Good example - Person is the brightest subject in the frame](good-example.png) +![Figure: Good example - Person is the brightest subject in the frame](good-video-background.png) ::: A good tip from [The Spruce blog](https://www.thespruce.com/tips-for-better-home-office-lighting-1812436) is to position your home office station facing north or south so that the sunlight doesn't throw a shadow at any point during the day, making you move your setup frequently. diff --git a/rules/have-good-lighting-on-your-home-office/good-example.png b/rules/have-good-lighting-on-your-home-office/video-background.png similarity index 100% rename from rules/have-good-lighting-on-your-home-office/good-example.png rename to rules/have-good-lighting-on-your-home-office/video-background.png diff --git a/rules/how-to-install-skypepop/1.png b/rules/how-to-install-skypepop/example-email-a-link.png similarity index 100% rename from rules/how-to-install-skypepop/1.png rename to rules/how-to-install-skypepop/example-email-a-link.png diff --git a/rules/how-to-install-skypepop/rule.md b/rules/how-to-install-skypepop/rule.md index f2a7596d5cc..b2b6b7908b2 100644 --- a/rules/how-to-install-skypepop/rule.md +++ b/rules/how-to-install-skypepop/rule.md @@ -32,11 +32,11 @@ Only receptionists should have SkypePOP installed. 2. The CRM contact pops up (or a "new contact" form if the number is not already in your CRM): -![Figure: Example contact popup on our CRM from incoming caller with the number +61420241201](1.png) +![Figure: Example contact popup on our CRM from incoming caller with the number +61420241201](example-email-a-link.png) 3. Send Email -![Figure: This email will be created – send it to the person you are forwarding the call to](2.png) +![Figure: This email will be created – send it to the person you are forwarding the call to](send-email.png) 4. Inform the person the call is being transferred to that you have sent him an email with the CRM Contact diff --git a/rules/how-to-install-skypepop/2.png b/rules/how-to-install-skypepop/send-email.png similarity index 100% rename from rules/how-to-install-skypepop/2.png rename to rules/how-to-install-skypepop/send-email.png diff --git a/rules/linkedin-creator-mode/Picture1.png b/rules/linkedin-creator-mode/bad-no-hashtag.png similarity index 100% rename from rules/linkedin-creator-mode/Picture1.png rename to rules/linkedin-creator-mode/bad-no-hashtag.png diff --git a/rules/linkedin-creator-mode/rule.md b/rules/linkedin-creator-mode/rule.md index 036048b7df0..edab65025e3 100644 --- a/rules/linkedin-creator-mode/rule.md +++ b/rules/linkedin-creator-mode/rule.md @@ -28,7 +28,7 @@ You can turn on creator mode to get access to [additional tools and features](ht For example, you can add topics you post the most about in the form of hashtags so users can find your profile when they are searching for a topic they want to learn more about. ::: bad -![Figure: Bad example - no hashtags](Picture1.png) +![Figure: Bad example - no hashtags](bad-no-hashtag.png) ::: ::: good diff --git a/rules/make-sure-all-software-uses-english/3.png b/rules/make-sure-all-software-uses-english/install-language-pack.png similarity index 100% rename from rules/make-sure-all-software-uses-english/3.png rename to rules/make-sure-all-software-uses-english/install-language-pack.png diff --git a/rules/make-sure-all-software-uses-english/rule.md b/rules/make-sure-all-software-uses-english/rule.md index 355edfc782d..8c1765aa090 100644 --- a/rules/make-sure-all-software-uses-english/rule.md +++ b/rules/make-sure-all-software-uses-english/rule.md @@ -141,7 +141,7 @@ Some cheap versions of Microsoft Office 365 only allow Chinese, so you need to u ::: ::: good - ![Figure: If you do not have the English version. In Microsoft Office open the rich client application such as Outlook or Word, then install and configure as per the image above](3.png) + ![Figure: If you do not have the English version. In Microsoft Office open the rich client application such as Outlook or Word, then install and configure as per the image above](install-language-pack.png) ::: ### How to fix on Office 365 (https://outlook.office365.com) diff --git a/rules/tax-invoice-vs-eftpos-receipt/Picture1.png b/rules/tax-invoice-vs-eftpos-receipt/invoice-receipt-1.png similarity index 100% rename from rules/tax-invoice-vs-eftpos-receipt/Picture1.png rename to rules/tax-invoice-vs-eftpos-receipt/invoice-receipt-1.png diff --git a/rules/tax-invoice-vs-eftpos-receipt/Picture4.png b/rules/tax-invoice-vs-eftpos-receipt/invoice-receipt-4.png similarity index 100% rename from rules/tax-invoice-vs-eftpos-receipt/Picture4.png rename to rules/tax-invoice-vs-eftpos-receipt/invoice-receipt-4.png diff --git a/rules/tax-invoice-vs-eftpos-receipt/rule.md b/rules/tax-invoice-vs-eftpos-receipt/rule.md index f8f28755176..b251fb39885 100644 --- a/rules/tax-invoice-vs-eftpos-receipt/rule.md +++ b/rules/tax-invoice-vs-eftpos-receipt/rule.md @@ -18,7 +18,7 @@ When you make purchases in-store by card, you typically receive 2 receipts: Tax They might seem like two peas in a pod, but they're different creatures serving different purposes. It is important to distinguish the difference between a Tax Invoice and Eftpos Payment Receipt—but let's be honest, the difference confuses most of us! -![](Picture1.png) +![](invoice-receipt-1.png) The primary purpose of a Tax Invoice is to provide a comprehensive record of a transaction for tax and accounting purposes. While an Eftpos Payment Receipt is like a digital high-five after you've paid for something using Eftpos. It's a record saying, "Yep, the payment went through!" @@ -91,4 +91,4 @@ The invoice is the official record that details why and where you spent that mon ![Figure:✅ Good example - Tax invoice submitted with Eftpos receipt together](Picture3.jpg) -![Figure:❌ Bad example - An Eftpos receipt doesn't tell you details on its own, and can't be used for tax deductions.](Picture4.png) +![Figure:❌ Bad example - An Eftpos receipt doesn't tell you details on its own, and can't be used for tax deductions.](invoice-receipt-4.png) diff --git a/rules/use-branch-protection/image001.jpg b/rules/use-branch-protection/bad-unprotected-main-branch.jpg similarity index 100% rename from rules/use-branch-protection/image001.jpg rename to rules/use-branch-protection/bad-unprotected-main-branch.jpg diff --git a/rules/use-branch-protection/rule.md b/rules/use-branch-protection/rule.md index e85f0aa45b9..0820a52894e 100644 --- a/rules/use-branch-protection/rule.md +++ b/rules/use-branch-protection/rule.md @@ -25,7 +25,7 @@ Using force push is dangerous and should be used with extreme caution, as it wil 4. Save changes ::: bad -![Bad example: Main branch not protected](image001.jpg) +![Bad example: Main branch not protected](bad-unprotected-main-branch.jpg) ::: ::: good diff --git a/rules/website-heatmaps/rule.md b/rules/website-heatmaps/rule.md index 443ea142477..abab66769a8 100644 --- a/rules/website-heatmaps/rule.md +++ b/rules/website-heatmaps/rule.md @@ -22,4 +22,4 @@ How can you work out where your site is going wrong and why? One key way to trac At SSW we use Microsoft Clarity to perform our heatmapping. This information then allows us to determine areas of our site are performing efficiently and areas we need to adjust for better performance. -![Figure: Heatmap from the SSW Consulting page](Picture3.png) +![Figure: Heatmap from the SSW Consulting page](ssw-heatmap.png) diff --git a/rules/website-heatmaps/Picture3.png b/rules/website-heatmaps/ssw-heatmap.png similarity index 100% rename from rules/website-heatmaps/Picture3.png rename to rules/website-heatmaps/ssw-heatmap.png From a8e8d2c0543d832d9292eeed0329cd54201b4358 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" Date: Fri, 9 Feb 2024 07:02:07 +0000 Subject: [PATCH 2/2] Auto-fix Markdown files --- rules/architecture-diagram/rule.md | 8 +-- rules/azure-devops-permissions/rule.md | 6 +- .../rule.md | 8 +-- rules/do-you-use-gzip/rule.md | 8 +-- .../rule.md | 2 +- .../rule.md | 2 - rules/do-you-use-pagespeed/rule.md | 1 - .../rule.md | 5 +- rules/how-to-install-skypepop/rule.md | 12 ++-- .../rule.md | 64 +++++++++---------- rules/tax-invoice-vs-eftpos-receipt/rule.md | 1 - rules/use-branch-protection/rule.md | 6 +- rules/website-heatmaps/rule.md | 2 +- 13 files changed, 58 insertions(+), 67 deletions(-) diff --git a/rules/architecture-diagram/rule.md b/rules/architecture-diagram/rule.md index f47b1a6a1c6..f99f4c6e55c 100644 --- a/rules/architecture-diagram/rule.md +++ b/rules/architecture-diagram/rule.md @@ -100,13 +100,13 @@ Group components logically by enclosing them in a box. Components that operate i ![Figure: Good example - SSW Rewards (Xamarin with Azure Active Directory B2C) - consistent styling is used. E.g. as well as all the icons and typography being consistent, you can see that data is a solid line and auth traffic is a dotted line](rewards-architecture-diagram.png) ::: -### Tip #6: Start with paper... +### Tip #6: Start with paper Make sure you use the right tools when creating your architecture diagrams. There's nothing wrong with starting out with pen and paper, but your hand-drawn sketch should not be considered your 'done' final architecture diagram. If you want to save paper, and increase collaboration, a great alternative is the trusty old whiteboard. -For me its all about building a shared understanding between the client and the developers. Most pieces of software architecture I do, work starts by building a rough solution architecture diagram on a whiteboard. +For me its all about building a shared understanding between the client and the developers. Most pieces of software architecture I do, work starts by building a rough solution architecture diagram on a whiteboard. -Putting something on a whiteboard is "low risk" for the participants as its really easy to wipe and redraw. It allows us to start working together straight away, building a shared understanding of what we're trying to achieve. There is no software or skills required to participate in whiteboard collaboration. +Putting something on a whiteboard is "low risk" for the participants as its really easy to wipe and redraw. It allows us to start working together straight away, building a shared understanding of what we're trying to achieve. There is no software or skills required to participate in whiteboard collaboration. > A key milestone in the early engagement is the first time a client takes the pen and starts using the whiteboard to explain something to me. Early use of the whiteboard is all about immediate communication. Later, the solution design starts to solidify and we can then use the last state of the whiteboard to make out first architecture diagram. > @@ -164,7 +164,7 @@ Maintain standards to keep your diagrams consistent: ### Tip #9: Where to store Diagrams? -Standardizing where your organisation stores architecture diagrams ensures a consistent experience among developers. Therefore store your architecture diagrams in the repo **docs**\ folder. Additionally, the \README.md (in the root) should have a link and an embedded image of the high-level architecture diagram (from the **docs**\\* folder). +Standardizing where your organisation stores architecture diagrams ensures a consistent experience among developers. Therefore store your architecture diagrams in the repo **docs**\ folder. Additionally, the \README.md (in the root) should have a link and an embedded image of the high-level architecture diagram (from the **docs**\\* folder). **Note:** If you have a Wiki, for visibility add an architecture diagram page and embed the images from the **docs**\\* folder. diff --git a/rules/azure-devops-permissions/rule.md b/rules/azure-devops-permissions/rule.md index 16adf037591..02454903cc3 100644 --- a/rules/azure-devops-permissions/rule.md +++ b/rules/azure-devops-permissions/rule.md @@ -21,9 +21,9 @@ Instead of giving Project Admin access to all team members in Azure DevOps, it i Example: To create Sprints in Azure DevOps, you only need two bits of permission: 1. Create child nodes on the backlog node for the team. - a. Navigate to the project in Azure DevOps | Project Settings + a. Navigate to the project in Azure DevOps | Project Settings b. Under "Boards" select Project configuration | Click on the ellipses (...) on Interations | Security -c. Add users and assign particular permission. +c. Add users and assign particular permission. ![Figure: Assign limited access to a particular user to create a Sprint ](child_node.jpg) @@ -32,5 +32,3 @@ c. Add users and assign particular permission. ![Figure: Team Administrator - Who have access to iterations in Azure DevOps](team-administrator.png) By following this rule and giving people only the specific permissions they need, you can help to ensure that Azure DevOps permissions are set up in a way that maximizes productivity and minimizes the risk of errors or unwanted changes. - - diff --git a/rules/do-you-know-how-to-enter-a-hubdoc-receipt/rule.md b/rules/do-you-know-how-to-enter-a-hubdoc-receipt/rule.md index 12914e171de..4c248eb404b 100644 --- a/rules/do-you-know-how-to-enter-a-hubdoc-receipt/rule.md +++ b/rules/do-you-know-how-to-enter-a-hubdoc-receipt/rule.md @@ -18,9 +18,9 @@ Hubdoc is great for tracking and accounting for receipts, but if you don't use i -To avoid confusion, add as much detail as possible about the purchase and who authorized it. To make this easier, your company can set some required fields to ensure that you have all of the relevant data entered for each claim. This will make your claims a lot more unified and easier to process. +To avoid confusion, add as much detail as possible about the purchase and who authorized it. To make this easier, your company can set some required fields to ensure that you have all of the relevant data entered for each claim. This will make your claims a lot more unified and easier to process. -![Figure: Users to accept invite to use Hubdoc](ac.png) +![Figure: Users to accept invite to use Hubdoc](ac.png) ![Figure: Take a photo with the Mobile Hubdoc app](de.png) @@ -28,12 +28,12 @@ To avoid confusion, add as much detail as possible about the purchase and who au ![Figure: Details that can be automated for Accounting reconciliation purposes](che.png) -The user or the administrator of the account can set up rules for each invoice in regards to their publication status and reconciliation details on the first instance. Going forward, any repeat of the invoice or the supplier will be filled in based on those rules set up. +The user or the administrator of the account can set up rules for each invoice in regards to their publication status and reconciliation details on the first instance. Going forward, any repeat of the invoice or the supplier will be filled in based on those rules set up. There is still an opportunity to review all the details, so setting up rules will simply fill in the repeat details each time. This is to ensure consistency in the reconciliations and save time for both user and the Accountant. Depending on the permissions of the User, they can also publish the invoice to Xero which can be recognised conveniently when completing the reconciliation process on Xero. -**Tip:** Hubdoc will automatically create folders to categorise the invoices and store for the user. These folders can be reorganised or renamed with ease. We recommend updating the folders early on so the invoices are collated in a useful manner for your business. +**Tip:** Hubdoc will automatically create folders to categorise the invoices and store for the user. These folders can be reorganised or renamed with ease. We recommend updating the folders early on so the invoices are collated in a useful manner for your business. ![Figure: Folders in Hubdoc](folders-in-Hubdoc.png) diff --git a/rules/do-you-use-gzip/rule.md b/rules/do-you-use-gzip/rule.md index 9597c9ce9b2..27242b7c264 100644 --- a/rules/do-you-use-gzip/rule.md +++ b/rules/do-you-use-gzip/rule.md @@ -24,7 +24,7 @@ For more information about how to use PageSpeed to find which files on your site Use one of the methods described below to add Gzip compression to your site ASP.Net/Angular website -* Method 1: Turn on "Dynamic Content Compression" In IIS Server. +* Method 1: Turn on "Dynamic Content Compression" In IIS Server. ![Figure: Choose the website which you want to use Gzip and click on Compression.](use-gzip-2.png) ![Figure: Install "dynamic content compression" if you haven't installed it.](use-gzip-3.png) @@ -34,11 +34,11 @@ Choose **Internet Information Services | Web Management Tools | World Wide Web S ![Figure: now enable dynamic content compression for your site.](use-gzip-5.png) * Method 2: Using “Gzipper” in your Angular website -Follow https://www.npmjs.com/package/gzipper (but it still need IIS Server enable static content compression). Using `npm i gzipper -g` to install "gzipper" first. Add to scripts in your package.json +Follow (but it still need IIS Server enable static content compression). Using `npm i gzipper -g` to install "gzipper" first. Add to scripts in your package.json ![](7.png) ![Figure: "Finish configuration like that.](use-gzip-6.png) -* Method 3: Using ASP.NET code in MVC Refer to https://www.codeproject.com/Tips/1080065/Improve-the-Performance-of-ASP-NET-MVC-Web-Application. +* Method 3: Using ASP.NET code in MVC Refer to . To implement this in ASP.NET MVC, we can utilize `ActionFilterAttribute` and override either `OnActionExecuting` or `OnResultExecuting` method. The below code snippet is being used to check whether the current request browser can accept GZIP/DEFLATE encoding by looking at Accept-Encoding request header. If it finds GZIP encoding in this header, then we would set gzip in Content-encoding in response header and if it supports DEFLATE, then this code would set deflate in Content-encoding. ```csharp @@ -93,7 +93,7 @@ To implement this in ASP.NET MVC, we can utilize `ActionFilterAttribute` and ove ::: bad Figure: Bad Example, files with large size and slow load time. ::: - + ::: good ![Figure: Good Example, gzipped files with smaller size and faster load time.](5.28.7.png) ::: diff --git a/rules/do-you-use-lead-magnets-as-part-of-your-marketing-strategy/rule.md b/rules/do-you-use-lead-magnets-as-part-of-your-marketing-strategy/rule.md index 12f0d670905..b3ae5c3d1fc 100644 --- a/rules/do-you-use-lead-magnets-as-part-of-your-marketing-strategy/rule.md +++ b/rules/do-you-use-lead-magnets-as-part-of-your-marketing-strategy/rule.md @@ -19,7 +19,7 @@ redirects: [] --- -In today’s overcrowded marketplace there are dozens of businesses offering the same goods and services with little to no variety, and for a consumer, this can result in it being hard to decide which one will provide the best value and service. Which is why Lead Magnets, if used correctly - can be a powerful addition to your overall Marketing Strategy. +In today’s overcrowded marketplace there are dozens of businesses offering the same goods and services with little to no variety, and for a consumer, this can result in it being hard to decide which one will provide the best value and service. Which is why Lead Magnets, if used correctly - can be a powerful addition to your overall Marketing Strategy. diff --git a/rules/do-you-use-optinmonster-for-your-content-downloads/rule.md b/rules/do-you-use-optinmonster-for-your-content-downloads/rule.md index eebbb43eb22..76fa40adea9 100644 --- a/rules/do-you-use-optinmonster-for-your-content-downloads/rule.md +++ b/rules/do-you-use-optinmonster-for-your-content-downloads/rule.md @@ -19,8 +19,6 @@ Content marketing is a great way to increase interest in your business and helps The best way to achieve this is to use gated content, which requires potential leads to provide their details in order to access the content offered. There are a number of platforms which allow you to create these forms and embed them onto your site. - - At SSW we did some research, and after initially using LeadPages, we decided to swap to OptinMonster. This choice was made for a few reasons, OptinMonster is significantly cheaper than LeadPages, and provides all the features we required including; form builders, pop-up forms, mobile friendly, A/B testing and tracking. ![](example-OptinMonster.png) **Figure: Example of OptinMonster pop-up form on [SSWTV](https://tv.ssw.com/) ** diff --git a/rules/do-you-use-pagespeed/rule.md b/rules/do-you-use-pagespeed/rule.md index 6099e3df88b..49fec4346ea 100644 --- a/rules/do-you-use-pagespeed/rule.md +++ b/rules/do-you-use-pagespeed/rule.md @@ -27,7 +27,6 @@ Install PageSpeed from [Chrome web store](https://chrome.google.com/webstore/det ![Figure: Install PageSpeed Insights (with PNaCl)](2d.png) - ### How to use PageSpeed? In Developer Tools (F12), you will have a new tab named PageSpeed. diff --git a/rules/do-you-use-the-best-code-analysis-tools/rule.md b/rules/do-you-use-the-best-code-analysis-tools/rule.md index c7a3b71ad33..a061b62cea2 100644 --- a/rules/do-you-use-the-best-code-analysis-tools/rule.md +++ b/rules/do-you-use-the-best-code-analysis-tools/rule.md @@ -38,7 +38,6 @@ Get ReSharper to green on each file you touch. You want the files you work on to * Alt + [Page Down/Page Up] : Next/Previous Resharper Error / Warning * Alt + Enter: Smart refactoring suggestions - ![Figure: ReSharper will show Orange when it detects that there is code that could be improved](48bc81\_image001.png) ![Figure: ReSharper will show green when all code is tidy](ReSharper-green.png) @@ -87,11 +86,11 @@ Create a **GlobalSuppressions.cs** file in your project with the rules that ![Figure: The suppressions file tells Code Analysis which rules it should disable for specific code blocks](suppressions-file.png) -**More Information:** [Do you make instructions at the beginning of a project and improve them gradually?](/do-you-make-instructions-at-the-beginning-of-a-project-and-improve-them-gradually) and https://docs.microsoft.com/en-us/visualstudio/code-quality/in-source-suppression-overview +**More Information:** [Do you make instructions at the beginning of a project and improve them gradually?](/do-you-make-instructions-at-the-beginning-of-a-project-and-improve-them-gradually) and ### Level 8 -The gold standard is to use +The gold standard is to use [SonarQube](https://www.sonarqube.org/), which gives you the code analysis that the previous levels give you as wells as the ability to analyze technical debt and to see which code changes had the most impact to technical debt ![Figure: SonarQube workflow with Visual Studio and Azure DevOps](2016-06-08\_12-59-38.png) diff --git a/rules/how-to-install-skypepop/rule.md b/rules/how-to-install-skypepop/rule.md index b2b6b7908b2..134db1368f1 100644 --- a/rules/how-to-install-skypepop/rule.md +++ b/rules/how-to-install-skypepop/rule.md @@ -15,7 +15,7 @@ redirects: --- All company receptionists should install SkypePOP on your PC. - + This will enable you to get Dynamics CRM contact popups on incoming calls, for example: 1. Bob Northwind calls you @@ -38,7 +38,6 @@ Only receptionists should have SkypePOP installed. ![Figure: This email will be created – send it to the person you are forwarding the call to](send-email.png) - 4. Inform the person the call is being transferred to that you have sent him an email with the CRM Contact 5. Wow! No one has to open the CRM manually anymore @@ -55,7 +54,7 @@ Only receptionists should have SkypePOP installed. 3. Add your CRM connection details -**Tip:** Go to Main | Settings | Customizations | Developer Resources in order to find the address for your CRM +**Tip:** Go to Main | Settings | Customizations | Developer Resources in order to find the address for your CRM ![Figure: Copy the Endpoint Address for your Organization Service](CRM_Endpoint_Address_SkypePOP.jpg) @@ -65,21 +64,20 @@ Only receptionists should have SkypePOP installed. ![Figure: Right-click on the icon in the taskbar and select 'Preferences'](2016-12-22_9-13-03.jpg) -5. Configure the **Dynamics CRM** settings to something similar to this: - +5. Configure the **Dynamics CRM** settings to something similar to this: + ![Figure: These are the default SkypePOP settings](50.jpg) 6. Open Skype for Business 7. Review the **SkypePOP - Skype for Business** settings - + ![Figure: These are the default Skype for Business settings](2016-11-18_16-44-59.jpg) 8. Ensure both Dynamics CRM and Skype for Business are connected by clicking on the tray icon ![Figure: Check that you are properly connected - blue is success](2016-11-18_16-47-00.jpg) - The SkypePOP demo license will stop working after 5 hours or 5 calls **Tip:** Reduce the time used by quitting SkypePOP - you do that by right clicking | Exit on the tray icon diff --git a/rules/make-sure-all-software-uses-english/rule.md b/rules/make-sure-all-software-uses-english/rule.md index 8c1765aa090..cb7ef51267e 100644 --- a/rules/make-sure-all-software-uses-english/rule.md +++ b/rules/make-sure-all-software-uses-english/rule.md @@ -42,30 +42,30 @@ You want all screenshots you take to be showing English. Most of the time it is In Chrome, you can follow these steps directly: -1. Three dots bar at the top right of the Chrome window: - +1. Three dots bar at the top right of the Chrome window: + ![Figure: Blank Chrome page showing the 'Settings' button, 3 small dots](chroooome.jpg) -2. Click on Settings: - +2. Click on Settings: + ![Figure: Showing the 'Settings' page](ssw12.png) -3. Click on Advanced: - +3. Click on Advanced: + ![Figure: Advanced tab in Settings](ssw13.png) -4. Click on 'Add Languages': - +4. Click on 'Add Languages': + ![Figure: Add Languages to your current Chrome](ssw14.png) -5. Move English to the top - +5. Move English to the top + ![Figure: Move English to top](ChromeEnOnTop.png) ### How to fix on a Mac? 1. Change the language in System Preferences. Go to **Apple menu | System Preferences | Language & Region** - + ![Figure: In macOS it’s simple to change to English](WX20180906-111514@2x.png) 2. In Preferred languages, add English and select it as primary language @@ -76,20 +76,20 @@ In Chrome, you can follow these steps directly: You should also change your Google language to English as well. If it is not already, take a look at these steps: -1. Go to www.google.com +1. Go to + +2. Click on `Sign-In` or `My Account` if you are already signed in -2. Click on `Sign-In` or `My Account` if you are already signed in - ![Figure: Google page without an account](ssw1.png) ![Figure: Google page with an account](ssw2.png) -3. Search for 'Language': - +3. Search for 'Language': + ![Figure: Search for 'language'](GoogleAccountSearch.png) -4. Now click `Language` and search for English - +4. Now click `Language` and search for English + ![Figure: Language picker](GoogleAccountAdd.png) 5. Move English up to default language by clicking on the arrow @@ -100,28 +100,28 @@ You should also change your Google language to English as well. If it is not alr ### How to fix your Gmail account? -1. Click on the cog then Settings - +1. Click on the cog then Settings + ![Figure: Access to Settings on Gmail](Gmail1.png) -2. Set language to English(US) - +2. Set language to English(US) + ![Figure: Change language setting](Gmail2.png) 3. Scroll down and click on 'Save Changes'. Done! ### How to fix Mozilla Firefox? -1. Go to Options - +1. Go to Options + ![Figure: Access to Firefox options](Firefox1.png) -2. Set Display language to English (United States), you may have to restart Firefox to apply the change - +2. Set Display language to English (United States), you may have to restart Firefox to apply the change + ![Figure: Language settings](Firefox2.png) -3. Choose your preferred language for displaying pages. Add English (United States) and move it to the top - +3. Choose your preferred language for displaying pages. Add English (United States) and move it to the top + ![Figure: Click Choose to change your preferred language](Firefox3a.png) ![Figure: Add English (United States) to your preferred language for displaying pages](Firefox3.png) @@ -144,9 +144,9 @@ Some cheap versions of Microsoft Office 365 only allow Chinese, so you need to u ![Figure: If you do not have the English version. In Microsoft Office open the rich client application such as Outlook or Word, then install and configure as per the image above](install-language-pack.png) ::: -### How to fix on Office 365 (https://outlook.office365.com) +### How to fix on Office 365 () -1. Go to https://outlook.office.com +1. Go to ![Figure: If you have the Inbox, Sent Items etc in Chinese then you will need to follow these steps](screenshot.png) @@ -166,12 +166,12 @@ Some cheap versions of Microsoft Office 365 only allow Chinese, so you need to u ![Figure: Set windows display language to English](LanguageSettingForWin10.png) -6. Go to **Settings | Language | Region**, click Regional format and select “English (United States)”. +6. Go to **Settings | Language | Region**, click Regional format and select “English (United States)”. ![Figure: Set regional format to English](RegionalFormatSettingForWin10.png) 7. In Outlook, go to **File | Options | Advanced | International options**, check "Use English for message headers..." - + ![Figure: Force message headers to English](outlook_options_headers.png) 8. Done. You have changed your language to English. Congratulations! diff --git a/rules/tax-invoice-vs-eftpos-receipt/rule.md b/rules/tax-invoice-vs-eftpos-receipt/rule.md index b251fb39885..46fcad73bd3 100644 --- a/rules/tax-invoice-vs-eftpos-receipt/rule.md +++ b/rules/tax-invoice-vs-eftpos-receipt/rule.md @@ -83,7 +83,6 @@ It usually shows information: | **Tax Invoice** | Primarily for tax and accounting purposes | Detailed information on products/services, taxes, and payment terms | Often required by tax authorities for proper documentation | | **Eftpos Payment Receipt** | Confirmation of payment | Focuses on transaction details, amount, and payment method | Serves as a customer receipt, not always legally mandated | - For businesses, maintaining tax invoices is a must for keeping solid accounting records and claiming tax or GST. Eftpos payment receipt is helpful and supplementary, especially when you've paid more than the invoiced amount (such as credit card surcharges). However, it's essential to note that while the Eftpos receipt confirms payment, it can't replace the role of a tax invoice. diff --git a/rules/use-branch-protection/rule.md b/rules/use-branch-protection/rule.md index 0820a52894e..556a4bcdf37 100644 --- a/rules/use-branch-protection/rule.md +++ b/rules/use-branch-protection/rule.md @@ -11,7 +11,7 @@ created: 2021-03-08T15:13:00.000Z archivedreason: null guid: 615dd407-2877-4c2d-b31a-60d75d42da3d --- -Branch protection is a feature in version control software that allows teams to define rules and restrictions around who can make changes to specific branches, and what types of changes are allowed. +Branch protection is a feature in version control software that allows teams to define rules and restrictions around who can make changes to specific branches, and what types of changes are allowed. Disabling the **Allow force pushes** and **Allow Deletions** settings on your main branch will protect the branch from accidentally being deleted and the history being rewritten. @@ -19,7 +19,7 @@ Using force push is dangerous and should be used with extreme caution, as it wil -1. Go to your repo | Settings | Branches +1. Go to your repo | Settings | Branches 2. If it doesn't already exist, create a branch protection rule on the 'main' or 'master' branch 3. Ensure 'Allow force pushes' and 'Allow Deletions' are disabled 4. Save changes @@ -40,4 +40,4 @@ You can use required status checks if you need to check that your code changes w ![Figure: Developers can't merge until all checks have passed](requiredChecks.png) ::: -See the GitHub docs [Require status checks before merging](https://docs.github.com/en/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#require-status-checks-before-merging) \ No newline at end of file +See the GitHub docs [Require status checks before merging](https://docs.github.com/en/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#require-status-checks-before-merging) diff --git a/rules/website-heatmaps/rule.md b/rules/website-heatmaps/rule.md index abab66769a8..d7d9af37ca7 100644 --- a/rules/website-heatmaps/rule.md +++ b/rules/website-heatmaps/rule.md @@ -19,7 +19,7 @@ The user experience on your site is crucial to ensuring that you are effectively How can you work out where your site is going wrong and why? One key way to track how users are viewing your site is **heatmapping**, which tracks the behaviour of your users on your site through mouse tracking and eye tracking techniques. - + At SSW we use Microsoft Clarity to perform our heatmapping. This information then allows us to determine areas of our site are performing efficiently and areas we need to adjust for better performance. ![Figure: Heatmap from the SSW Consulting page](ssw-heatmap.png)