Merge pull request #293 from srobo/updates-page

Updates page

Author: RealOrangeOne

_data/kit_versions.yml

@@ -0,0 +1,2 @@
+- version: 2022.0.0
+  released: 2021-11-13

_data/sidebar_tree.yaml

@@ -17,6 +17,9 @@ tree:
         title: IMAX B6 Charger
     - url: /kit/brain_board
       title: Brain Board
+      tree:
+        - url: /kit/brain_board/updates
+          title: Updates
     - url: /kit/motor_board
       title: Motor Board
     - url: /kit/power_board

_includes/script.html

@@ -11,5 +11,6 @@
 {% endif %}
 
 <script defer data-domain="studentrobotics.org" src="https://plausible.io/js/plausible.js"></script>
+<script>window.plausible = window.plausible || function() { (window.plausible.q = window.plausible.q || []).push(arguments) }</script>
 
 <script src="{{ '/js/navigation.js' | prepend: site.baseurl }}"></script>

_includes/updates-table.html

@@ -0,0 +1,27 @@
+<table id="updates-table">
+  <tr>
+    <th></th>
+    <th>Release Date</th>
+    <th>Download</th>
+    <th>Licences</th>
+  </tr>
+  {% for kit_version in site.data.kit_versions %}
+    {% assign version = kit_version.version %}
+    <tr id="{{ version | slugify }}">
+      <td>
+        {% if forloop.first %}
+        <code><strong>{{ version }}</strong></code>
+        {% else %}
+        <code>{{ version }}</code>
+        {% endif %}
+      </td>
+      <td>{{ kit_version.released | date_to_string }}</td>
+      <td>
+        <a class="kit-download-link" data-version="{{ version }}" href="https://kit-downloads.studentrobotics.org/kit-software/{{ version }}/srobo-robot-{{ version }}.img.xz">
+          Download {{ version }}
+        </a>
+      </td>
+      <td><a href="https://kit-downloads.studentrobotics.org/kit-software/{{ version }}/srobo-robot-{{ version }}-licences">Licences</a></td>
+    </tr>
+  {% endfor %}
+</table>

js/updates.js

@@ -0,0 +1,17 @@
+function handleDownloadClick(event) {
+  plausible("Kit download", {props: {version: event.target.dataset.version}});
+
+  // Delay navigation so that Plausible is notified of the click
+  setTimeout(function() {
+    location.href = event.target.href;
+  }, 150);
+  event.preventDefault();
+}
+
+function addDownloadTracking() {
+  document.querySelectorAll("#updates-table .kit-download-link").forEach(function(link) {
+    link.addEventListener("click", handleDownloadClick);
+  });
+}
+
+window.addEventListener('load', addDownloadTracking);

kit/brain_board.md renamed to kit/brain_board/index.md

@@ -3,6 +3,13 @@ layout: page
 title: Brain Board
 ---
 
+{% comment %}
+The below will automatically calculate the latest version number, to be used when mentioning the version in this page.
+{% endcomment %}
+
+{% assign latest_version = site.data.kit_versions | first %}
+{% assign latest_version = latest_version.version %}
+
 Brain Board
 ===========
 
@@ -17,23 +24,21 @@ The SD card is located on the underside of the board. Carefully open the Brain B
 
 To fully update your Brain Board's software, or refresh it if you think it's not working correctly, you can flash our SD card image onto the microSD card in your Brain Board.
 
-To update the SD card, you'll need to download our image, [`srobo-robot-2022.0.0.img.xz`][robot-image].
+To update the SD card, you'll need to download our image from the [updates page]({{ site.baseurl }}/kit/brain_board/updates). The latest version is `{{ latest_version }}`.
 The flashing procedure is identical to flashing Raspberry Pi images.
 
-[robot-image]: https://kit-downloads.studentrobotics.org/kit-software/2022.0.0/srobo-robot-2022.0.0.img.xz
-
 ## Etcher
 
 We recommend using [etcher](https://etcher.io), as it's simple to use, and available on Windows, macOS and Linux. If you're familiar with Raspberry Pis or other similar boards and have flashed images before with a different tool, that will also work.
 
 ![Etcher example]({{ site.baseurl }}/images/content/kit/etcher.png)
 
 <div class="info" markdown="1">
-If you choose to use a tool other than Etcher, you may need to extract the `srobo-robot-2022.0.0.img.xz` to `srobo-robot-2022.0.0.img`. There are many tools available for this, e.g. [7-zip](http://www.7-zip.org/).
+If you choose to use a tool other than Etcher, you may need to extract the `srobo-robot-{{ latest_version }}.img.xz` to `srobo-robot-{{ latest_version }}.img`. There are many tools available for this, e.g. [7-zip](http://www.7-zip.org/).
 </div>
 
 ### Flashing
 
-1. Open Etcher and select the `srobo-robot-2022.0.0.img.xz` file you downloaded
+1. Open Etcher and select the `srobo-robot-{{ latest_version }}.img.xz` file you downloaded
 2. Select your SD card from the devices window
 3. Click 'Flash!'

kit/brain_board/updates.md

@@ -0,0 +1,17 @@
+---
+layout: page
+title: Updates
+extra_js: updates
+---
+
+# Updates
+
+Keeping your kit up to date is very important. It enables us to deploy new features, as well as fix bugs.
+
+Once you have downloaded the file you need, refer to the documentation on [updating your brain board]({{ site.baseurl }}/kit/brain_board#flashing-sd-card) to apply the update.
+
+Each update file is a complete upgrade. Each file contains the changes of those before it. If you need to jump up multiple versions, you can do so by using the latest file.
+
+The following table outlines the updates which have been published.
+
+{% include updates-table.html %}