Migrate guides to cloudflare

Archit-Jain-Github · Jan 5, 2024 · 7ac3471 · 7ac3471
1 parent 3d80dc9
commit 7ac3471
Show file tree

Hide file tree

Showing 5 changed files with 10 additions and 15 deletions.
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -18,7 +18,7 @@ This PR is:
 -->
 
 - [ ] I used the uncompressed size of the site
-- [ ] I have included a link to the GTMetrix report
+- [ ] I have included a link to the Cloudflare report
 - [ ] This site is not an ultra lightweight site
 - [ ] The following information is filled identical to the data file
 
@@ -33,4 +33,4 @@ This PR is:
   last_checked:
 ```
 
-GTMetrix Report: 
+Cloudflare Report: 
diff --git a/.gitignore b/.gitignore
@@ -3,5 +3,3 @@ _site
 .jekyll-metadata
 *-cache/
 .DS_Store
-
-python-gtmetrix
diff --git a/README.md b/README.md
@@ -14,11 +14,11 @@ But we can make a difference - all it takes is some optimisation. Do you really
 ## How to create a PR to add your site to the 512KB Club
 
 1. Fork this repository.
-2. Get the **UNCOMPRESSED** size of your website's homepage.
-    1. Do a <a target="_blank" href="https://gtmetrix.com">GTMetrix scan</a> on your website.
-    2. Once complete, click on the **Waterfall** tab to make sure the **uncompressed** size of your site is less than 512KB.
+2. Get the size of your website's homepage.
+    1. Do a <a target="_blank" href="https://radar.cloudflare.com/scan">Cloudflare URL Scan</a> on your website.
+    2. Once complete, check the "Bytes Total" stat in the "Network" card to make sure the **uncompressed** size of your site is less than 512KB.
 3. Navigate to [`_data/sites.yml`](./_data/sites.yml) and add your site (template below).
-4.  **When creating the PR, please include a link to the GT Metrix results in the PR comment.**
+4.  **When creating the PR, please include a link to the Cloudflare scan results in the PR description.**
 
 ### Site template
 
@@ -38,7 +38,3 @@ But we can make a difference - all it takes is some optimisation. Do you really
 ```
 
 **NOTE:** Entries are automatically sorted by domain name. Please add your site to the list without worrying about the alphabetical order. Our continuous integration process will handle the sorting for you. Just ensure that the details for your site are correctly formatted as per the existing entries.
-
-## Automation of site size check
-
-You can find [instructions](scripts/docs_site_size_rechecker.md) on how to get the GTmetrix size using a script in the [scripts](scripts/) folder
diff --git a/_includes/faq-01.html b/_includes/faq-01.html
@@ -4,9 +4,8 @@
         instructions:</p>
 
     <ol>
-        <li>Do a <a target="_blank" href="https://gtmetrix.com">GTMetrix scan</a> on your website.</li>
-        <li>Once complete, click on the <b>Waterfall</b> tab to make sure the <b>uncompressed</b> size of your site is
-            less than 512KB.</li>
+        <li>Do a <a target="_blank" href="https://radar.cloudflare.com/scan">Cloudflare URL Scan</a> on your website.</li>
+        <li>Once complete, check the "Bytes Total" stat in the "Network" card to make sure the **uncompressed** size of your site is less than 512KB.</li>
         <li>If your site satisfies this requirement, create a pull request (<a target="_blank"
                 href="https://github.com/kevquirk/512kb.club/blob/master/README.md#how-to-create-a-pr-to-add-your-site-to-the-512kb-club">instructions
                 here</a>) to add your site.</li>

diff --git a/scripts/docs_site_size_rechecker.md b/scripts/docs_site_size_rechecker.md
@@ -1,5 +1,7 @@
 # Site Size Rechecker Script Documentation
 
+> **🚨 IMPORTANT 🚨**: This document is out of date, as we're no longer using GTMetrix. We since migrated to Cloudflare. More information can be found [here](https://github.com/kevquirk/512kb.club/issues/1366).
+
 ## Purpose
 The main purpose of `site_size_rechecker.py` script is to automate the checking of older sites that are listed in the 512kb.club and ensuring that the size is updated.