Skip to content

Commit e62e6b0

Browse files
committed
Add documentation, use absolute links in index
1 parent b501e41 commit e62e6b0

File tree

2 files changed

+16
-3
lines changed

2 files changed

+16
-3
lines changed

README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -141,3 +141,16 @@ For images that are "above the fold" (that will be seen by users immediately aft
141141
```html
142142
<img class="my-class" src="my/src.png" loading="eager" />
143143
```
144+
145+
### Automated quality checks
146+
147+
A workflow on GitHub Actions is run at every push and for every pull request to ensure basic integrity of the website:
148+
- [validating](https://validator.w3.org/docs/help.html#validation_basics) the structure of the HTML using [Nu validator](https://validator.github.io/validator/) to ensure compliance with HTML standards
149+
- checking linked URLs for errors (including expired certificates)
150+
- running [Lighthouse](https://github.com/GoogleChrome/lighthouse) audits to ensure performance, accessibility, SEO optimization and best practices
151+
152+
If pre-defined quality targets are not met, the jobs will fail.
153+
Click on "Details" link for the failing job to see what caused the failure.
154+
155+
The detailed results will be available in the logs (which are only shown to users logged in on GitHub),
156+
including links to full Lighthouse reports on public temporary storage (the links will expire after 7 days).

index.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -54,10 +54,10 @@
5454
height: 627
5555
buttons:
5656
- class:
57-
href: try
57+
href: /try
5858
text: Try it in your browser
5959
- class: install-button
60-
href: install
60+
href: /install
6161
text: Install the Notebook
6262
features:
6363
- headline: Language of choice
@@ -112,7 +112,7 @@
112112
alt: icon to represent data
113113
src: assets/data.svg
114114
button:
115-
href: hub
115+
href: /hub
116116
text: Learn more about JupyterHub
117117

118118
voila:

0 commit comments

Comments
 (0)