Skip to content

Commit 3d3ca7b

Browse files
authored
update Rocket Validator guide (#241)
1 parent 2926297 commit 3d3ca7b

File tree

1 file changed

+11
-5
lines changed

1 file changed

+11
-5
lines changed

ROCKET-VALIDATOR.md

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -15,17 +15,17 @@ Both checkers are free and open source, and can be used on individual URLs.
1515

1616
Rocket Validator is a web crawler and reporting tool that lets you automatically check thousands of URLs (or just a few) with a single click.
1717

18-
The current site for Beta Elixir School has 1,040 web pages. Imagine if you had to check each web page manually, both for HTML and accessibility issues. That's 2,080 checks needed!
18+
The current site for Elixir School has more than 1,000 web pages. Imagine if you had to check each web page manually, both for HTML and accessibility issues. That's more than 2,000 checks needed!
1919

2020
RV lets us automate this site-wide checking and also schedule periodic checks to constantly monitor for new issues.
2121

2222
## Create your RV account
2323

24-
RV is a paid service but Elixir School contributors have a free Pro account to work on this site. If you're an Elixir School contributor you just need to [sign up](https://rocketvalidator.com/registration/new) for a free account, and contact [[email protected]](mailto:[email protected]) to have your account upgraded to Pro.
24+
RV is a paid service but Elixir School contributors have a free Pro account to work on this site. If you're an Elixir School contributor you just need to [sign up](https://rocketvalidator.com/registration/new) for a free account, and contact [[email protected]](mailto:[email protected]) to have your account upgraded to Pro for free.
2525

2626
## Create your first report
2727

28-
Once you're logged in at RV, you can [create a new report](https://rocketvalidator.com/s/new). You just need to enter a starting URL (https://beta.elixirschool.com), and click on **Start validation**.
28+
Once you're logged in at RV, you can [create a new report](https://rocketvalidator.com/s/new). You just need to enter a starting URL (https://elixirschool.com), and click on **Validate**.
2929

3030
Your site validation report will be created, and the crawler will find the internal web pages, and validate each one for HTML and accessibility issues.
3131

@@ -50,13 +50,19 @@ There are some issues that we can decide not to fix, for example HTML markup tha
5050
* A string to match URLs. It can be a whole URL if you want to be specific, or just a substring like `elixirschool`, which is recommended as it will match both on the beta, staging and production sites, as well as your ngrok instances if you include that on the name.
5151
* A string to match the issue message. A substring is enough, for example matching on `Attribute “phx-` will hide all issues regarding about invalid attributes set by Phoenix.
5252

53-
Each RV user defines their own muting rules, here are the rules [that we've agreed to mute](https://rocketvalidator.com/domains/elixirschool.com?tab=mutings&auth=171c6160-f0a2-49d9-b83f-065c15c8a072).
53+
Each RV user defines their own muting rules, but here are some suggestions:
54+
55+
| URL match | Message match | Comments |
56+
|--------------------------|-----------------|-------------------------------|
57+
| https://elixirschool.com | Attribute “phx- | Required by Phoenix framework |
58+
| https://elixirschool.com | Attribute “@ | Required by Alpine.js |
59+
| https://elixirschool.com | Attribute “x | Required by Alpine.js. |
5460

5561
## Shared Domain Stats
5662

5763
RV generates daily domain stats based on the reports you run, which can be shared by RV users. We're using the ones shared from @jaimeiniesta's account as a central reference:
5864

59-
[Latest Stats and Reports for Beta Elixir School](https://rocketvalidator.com/domains/elixirschool.com?auth=171c6160-f0a2-49d9-b83f-065c15c8a072)
65+
[Latest Stats and Reports for Elixir School](https://rocketvalidator.com/stats/elixirschool.com)
6066

6167
## Scheduling Reports
6268

0 commit comments

Comments
 (0)