www: adjust headers and decscriptions

- make it more obvious how tests are categorized - make it clear the conformance is wider than just HTTP Gateway funcitonality - add canonical link
ipfs · Nov 7, 2023 · ee75253 · ee75253
1 parent fa87c6a
commit ee75253
Show file tree

Hide file tree

Showing 5 changed files with 23 additions and 9 deletions.
diff --git a/www/config.yaml b/www/config.yaml
@@ -1,4 +1,4 @@
-baseURL: http://example.org/
+baseURL: https://conformance.ipfs.tech/
 languageCode: en-us
 title: Gateway Conformance Dashboard
 

diff --git a/www/content/current.md b/www/content/current.md
@@ -1,12 +1,14 @@
 ---
-title: Testing Dashboard
+title: By Reference Implementation
 published: true
 menu:
     main:
         weight: 10
 ---
 
-This table shows the test results organized by test groups and implementations. Click on any row or cell to drill down into the tests results.
+This table shows the test results organized by test groups and reference implementations. Click on any row or cell to drill down into the tests results.
+
+See [README](https://github.com/ipfs/gateway-conformance/#readme) for instructions how to run these tests in your own CI against your own implementation.
 
 <!--more-->
 

diff --git a/www/content/specs/_index.md b/www/content/specs/_index.md
@@ -1,5 +1,5 @@
 ---
-title: Specification Dashboard
+title: By Specification
 published: true
 menu:
     main:
@@ -8,4 +8,6 @@ menu:
 
 This table shows the test results organized by specifications and implementations. Click on any row or cell to drill down into the tests results. Click on any "Children Spec Test Suite" or "Section Test Suite" to drill down into results.
 
-<!--more-->
+See [README](https://github.com/ipfs/gateway-conformance/#readme) for instructions how to run these tests in your own CI against your own implementation.
+
+<!--more-->
diff --git a/www/themes/conformance/layouts/_default/baseof.html b/www/themes/conformance/layouts/_default/baseof.html
@@ -12,11 +12,20 @@
       <div class="mx-auto max-w-7xl px-4 sm:px-6 lg:px-8 py-10 text-white">
         <img src="{{ "logo.png" | absURL }}" alt="Conformance Testing Logo" class="w-32 h-32" />
         <h1 class="my-6">
-        IPFS Gateway Conformance
+        IPFS Gateway Conformance Test Suite
         </h1>
         <p>
-          The purpose of <em>IPFS Gateway Conformance</em> is to provide a vendor-agnostic gateway conformance test suite for users and implementers of IPFS Gateways. We ensure compliance with <a href="https://specs.ipfs.tech/http-gateways/">specs.ipfs.tech</a>.
-          Find us on <a href="https://github.com/ipfs/gateway-conformance">Github</a>.
+          The purpose of <em>IPFS Gateway Conformance</em> is to provide a HTTP-based, vendor-agnostic conformance test suite for users and implementers of IPFS.
+        </p>
+        <p>
+          It ensures implementations comply with a subset of <a
+            href="https://specs.ipfs.tech/">IPFS Specifications</a> beyond HTTP
+          Gateway functionality. Tests included in this suite can be used to verify the
+          implementations of data formats beyond raw blocks and
+          CARs, such as HAMT-sharded UnixFS, DAG-CBOR, or even DNSLink and IPNS Records.
+        </p>
+        <p>
+          Learn how to use this in your own project on <a href="https://github.com/ipfs/gateway-conformance#readme">Github</a>.
         </p>
       </div>
     </header>

diff --git a/www/themes/conformance/layouts/partials/head.html b/www/themes/conformance/layouts/partials/head.html
@@ -3,9 +3,10 @@
 
 {{ $styles := resources.Get "style.css" }}
 <link rel="stylesheet" href="{{ $styles.RelPermalink }}"/>
+<link rel="canonical" href="{{ .Permalink | safeURL }}" />
 
 {{ with .Params.RedirectsTo }}
     <meta http-equiv="refresh" content="0; url={{ . | absURL }}"/>
 {{ end }}
 
-{{ .Params.RedirectsTo }}
+{{ .Params.RedirectsTo }}