Validate HTML with HTMLProofer, Closes #12

comunica · May 5, 2021 · 65674aa · 65674aa
1 parent c8dd94d
commit 65674aa
Show file tree

Hide file tree

Showing 13 changed files with 40 additions and 22 deletions.
diff --git a/.github/htmlproofer.sh b/.github/htmlproofer.sh
@@ -0,0 +1,9 @@
+#!/bin/bash
+
+htmlproofer ./out/ \
+    --allow-hash-href true \
+    --check-favicon true \
+    --check-html true \
+    --http-status-ignore "429" \
+    --url-ignore "https://query.2020.eswc-conferences.org/,https://2019.eswc-conferences.org/" \
+    --extension .html
diff --git a/.github/workflows/deploy-gh-pages.yml b/.github/workflows/deploy-gh-pages.yml
@@ -16,14 +16,21 @@ jobs:
         uses: actions/[email protected]
         with:
           persist-credentials: false
-
       - name: Install and Build 🔧
         run: |
           npm install
           npm run build
           touch out/.nojekyll
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 2.6
+      - name: Check HTML ✅
+        run: |
+          gem install html-proofer
+          .github/htmlproofer.sh
       - name: Deploy 🚀
         uses: JamesIves/[email protected]
         with:

diff --git a/components/Navigation.js b/components/Navigation.js
@@ -4,8 +4,8 @@ export default class Navigation extends React.Component {
     render() {
         return <nav>
             <div>
-                <a href="/"><img src="/img/comunica_white.svg" className="nav-icon" /></a>
-                <a href="#" className="toggle-nav"><img src="/img/navigation-toggle.svg" /></a>
+                <a href="/"><img src="/img/comunica_white.svg" className="nav-icon" alt="Comunica logo" /></a>
+                <a href="#" className="toggle-nav"><img src="/img/navigation-toggle.svg" alt="Toggle navigation bar" /></a>
             </div>
             <ul>
                 <li><a href="http://query.linkeddatafragments.org/">Try live</a></li>

diff --git a/pages/_document.js b/pages/_document.js
@@ -11,7 +11,9 @@ class MyDocument extends Document {
     render() {
         return (
             <Html>
-                <Head/>
+                <Head>
+                    <link rel="icon" href="/favicon.ico"/>
+                </Head>
                 <body>
                 <Navigation />
                 <div className="nav-pusher"/>

diff --git a/pages/ask.md b/pages/ask.md
@@ -29,7 +29,7 @@ feel free to report them in our [issue tracker on GitHub](https://github.com/com
 Please take into account that this is an open-source effort,
 so we may not be able to solve all issues, but we do our best!
 Should you be interested in helping our with fixing or implementing any of these issues,
-you are very welcome to [contribute](contribute/).
+you are very welcome to [contribute](/contribute/).
 
 ## Twitter
 

diff --git a/pages/docs/1_query/3_faq.md b/pages/docs/1_query/3_faq.md
@@ -65,7 +65,7 @@ and an `'end'` event will only be emitted when all of them have been consumed.
 ## I need a specific feature, how do I get it into Comunica?
 
 Since Comunica is an open-source project,
-the best way to get new features in, is by [contributing yourself](/contributing/).
+the best way to get new features in, is by [contributing yourself](/contribute/).
 
 Feel free to [contact us](/ask/) for commercial support or consultancy.
 
@@ -74,7 +74,7 @@ Feel free to [contact us](/ask/) for commercial support or consultancy.
 ### Simple statistics
 
 The easiest way to get statistics on the performance of a specific query
-is by using the `'stats'` [result format](/docs/query/advanced/result_format/).
+is by using the `'stats'` [result format](/docs/query/advanced/result_formats/).
 This will print the number of results, their delay from query start,
 and the number of HTTP requests that have been executed up until the result was available.
 

diff --git a/pages/docs/1_query/advanced/destination_types.md b/pages/docs/1_query/advanced/destination_types.md
@@ -31,7 +31,7 @@ which may produce incorrect results. For these cases, the <code>sparql</code> ty
 </div>
 
 <div class="note">
-When enabling the <a href="/docs/query/getting_started/logger/"><code>info</code> logger</a>,
+When enabling the <a href="/docs/modify/advanced/logging/"><code>info</code> logger</a>,
 you can derive what type Comunica has determined for each destination.
 </div>
 

diff --git a/pages/docs/1_query/advanced/source_types.md b/pages/docs/1_query/advanced/source_types.md
@@ -20,7 +20,7 @@ which may produce incorrect results. For these cases, the <code>sparql</code> ty
 </div>
 
 <div class="note">
-When enabling the <a href="/docs/query/getting_started/logger/"><code>info</code> logger</a>,
+When enabling the <a href="/docs/modify/advanced/logging/"><code>info</code> logger</a>,
 you can derive what type Comunica has determined for each source.
 </div>
 

diff --git a/pages/docs/2_modify/1_getting_started/1_custom_config_cli.md b/pages/docs/2_modify/1_getting_started/1_custom_config_cli.md
@@ -93,7 +93,7 @@ For example, the imported config file `files-cais:config/sets/sparql-queryoperat
 }
 ```
 
-This example `files-cais:config/sets/sparql-queryoperators.json` config file contains three _[actors](/docs/modify/advanced/architecture/)_ that will be loaded into Comunica,
+This example `files-cais:config/sets/sparql-queryoperators.json` config file contains three _[actors](/docs/modify/advanced/architecture_core/)_ that will be loaded into Comunica,
 which each fulfill a specific task:
 
 * `ActorQueryOperationDistinctHash`: Executes the SPARQL `DISTINCT` operator.

diff --git a/pages/docs/2_modify/advanced/query_output_types.md b/pages/docs/2_modify/advanced/query_output_types.md
@@ -19,13 +19,13 @@ All relevant types and interfaces are exposed by the
 [`IActorQueryOperationOutput`](https://comunica.github.io/comunica/modules/bus_query_operation.html#iactorqueryoperationoutput-1)
 is a TypeScript union type over the following interfaces:
 
-* [`IActorQueryOperationOutputBindings`](https://comunica.github.io/comunica/interfaces/bus_query_operation.iactorqueryoperationoutputbindings.html): Represents a stream of bindings.
-* [`IActorQueryOperationOutputQuads`](https://comunica.github.io/comunica/interfaces/bus_query_operation.iactorqueryoperationoutputquads.html): Represents a stream of quads.
-* [`IActorQueryOperationOutputBoolean`](https://comunica.github.io/comunica/interfaces/bus_query_operation.iactorqueryoperationoutputboolean.html): Represents a boolean result.
+* [`IActorQueryOperationOutputBindings`](https://comunica.github.io/comunica/modules/bus_query_operation.html#iactorqueryoperationoutputbindings): Represents a stream of bindings.
+* [`IActorQueryOperationOutputQuads`](https://comunica.github.io/comunica/modules/bus_query_operation.html#iactorqueryoperationoutputquads): Represents a stream of quads.
+* [`IActorQueryOperationOutputBoolean`](https://comunica.github.io/comunica/modules/bus_query_operation.html#iactorqueryoperationoutputboolean): Represents a boolean result.
 
 ## Bindings output
 
-An output of type [`IActorQueryOperationOutputBindings`](https://comunica.github.io/comunica/interfaces/bus_query_operation.iactorqueryoperationoutputbindings.html)
+An output of type [`IActorQueryOperationOutputBindings`](https://comunica.github.io/comunica/modules/bus_query_operation.html#iactorqueryoperationoutputbindings)
 looks as follows:
 
 ```typescript
@@ -45,7 +45,7 @@ which are of type `Map<string, RDF.Term>` where keys are variable names prefixes
 
 ## Quads output
 
-An output of type [`IActorQueryOperationOutputQuads`](https://comunica.github.io/comunica/interfaces/bus_query_operation.iactorqueryoperationoutputquads.html)
+An output of type [`IActorQueryOperationOutputQuads`](https://comunica.github.io/comunica/modules/bus_query_operation.html#iactorqueryoperationoutputquads)
 looks as follows:
 
 ```typescript
@@ -62,7 +62,7 @@ containing [RDF/JS quads](/docs/query/advanced/rdfjs/).
 
 ## Boolean output
 
-An output of type [`IActorQueryOperationOutputBoolean`](https://comunica.github.io/comunica/interfaces/bus_query_operation.iactorqueryoperationoutputboolean.html)
+An output of type [`IActorQueryOperationOutputBoolean`](https://comunica.github.io/comunica/modules/bus_query_operation.html#iactorqueryoperationoutputboolean)
 looks as follows:
 
 ```typescript

diff --git a/pages/index.js b/pages/index.js
@@ -8,7 +8,7 @@ export default function Home() {
           description={'Flexible SPARQL and GraphQL over decentralized RDF on the Web.'}
       />
 
-      <main>
+      <main id="software">
         <div className={"intro"}>
           <img src="/img/comunica_red.svg" alt="Comunica" className="comunica-logo" />
           <h1 className="title">A knowledge graph querying framework</h1>

diff --git a/pages/research.md b/pages/research.md
@@ -10,7 +10,7 @@ as a framework for researching query execution over decentralized knowledge grap
 Since Comunica is open-source, anyone is free to use it to perform any research they want.
 
 If you are interested in **collaborating**, or working on Comunica as a **Bachelor/Master/PhD student**,
-feel free to [contact us](ask/#email).
+feel free to [contact us](/ask/#email).
 We always have interesting projects to offer on both applied development and fundamental research.
 
 ## Cite
@@ -48,7 +48,7 @@ The following publications make significant use of Comunica:
 * [**SAD Generator: eating our own dog food to generate KGs and websites for academic events**. Heyvaert, P., Chaves-Fraga, D., Priyatna, F., Sequeda, J., & Dimou, A. (2019, June).](https://link.springer.com/chapter/10.1007/978-3-030-32327-1_19)
 * [**Versioned Querying with OSTRICH and Comunica in MOCHA 2018**. Taelman, R., Vander Sande, M., & Verborgh, R. (2018, June)](https://biblio.ugent.be/publication/8566999/file/8567001.pdf)
 
-Also using Comunica in our work? [Let us know](ask/#email) so we can add a reference to this list.
+Also using Comunica in our work? [Let us know](/ask/#email) so we can add a reference to this list.
 
 ## Tutorials
 

diff --git a/pages/research/amf.md b/pages/research/amf.md
@@ -29,23 +29,23 @@ Due to the reduction of HTTP requests, complete results come in earlier.
 In some cases, the first result can be delayed.
 
 <center>
-  <img src="https://comunica.github.io/Article-SSWS2020-AMF/img/experiments/client_algos/query_times_F3.svg" style="width:75%" \>
+  <img src="https://comunica.github.io/Article-SSWS2020-AMF/img/experiments/client_algos/query_times_F3.svg" alt="Query times for F3" style="width:75%" \>
 </center>
 
 ### Caching significantly speeds up query execution
 
 An HTTP cache like NGINX achieves the best results, but additionally caching AMF filters server-side is not worth the effort.
 
 <center>
-  <img src="https://comunica.github.io/Article-SSWS2020-AMF/img/experiments/caching/plot_no_c.svg" style="width:75%" \>
+  <img src="https://comunica.github.io/Article-SSWS2020-AMF/img/experiments/caching/plot_no_c.svg" alt="Query times for caching" style="width:75%" \>
 </center>
 
 ### Extreme false-positive probabilities slow down query execution
 
 On average, a false-positive probability of 1/64 leads to the lowest overall query evaluation times for this experiment.
 
 <center>
-  <img src="https://comunica.github.io/Article-SSWS2020-AMF/img/experiments/probabilities/plot_no_c.svg" style="width:75%" \>
+  <img src="https://comunica.github.io/Article-SSWS2020-AMF/img/experiments/probabilities/plot_no_c.svg" alt="Query times for different false-positive probabilities" style="width:75%" \>
 </center>
 
 ## 3. Recommendations for data publishers