Skip to content

Commit e13d938

Browse files
committed
Create a page to list kit versions and updates
1 parent a32fce2 commit e13d938

File tree

3 files changed

+64
-5
lines changed

3 files changed

+64
-5
lines changed

_layouts/updates.html

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
---
2+
layout: default
3+
---
4+
<div class="header-card">
5+
<div class="fixed-width">
6+
<h1>Documentation</h1>
7+
</div>
8+
</div>
9+
<div class="mobile-only mobile-index">
10+
{% include sidebar.html %}
11+
</div>
12+
<div class="main">
13+
<div class="row fixed-width">
14+
<div class="column m-3-12 desktop-only">
15+
{% include sidebar.html %}
16+
</div>
17+
<div class="column m-9-12 doc">
18+
{{ content }}
19+
20+
<table>
21+
<tr>
22+
<th></th>
23+
<th>Release Date</th>
24+
<th>Download</th>
25+
<th>Licences</th>
26+
</tr>
27+
{% for kit_version in page.kit_versions %}
28+
<tr>
29+
<td>
30+
{% if forloop.first %}
31+
<code><strong>{{ kit_version.version }}</strong></code>
32+
{% else %}
33+
<code>{{ kit_version.version }}</code>
34+
{% endif %}
35+
</td>
36+
<td>{{ kit_version.released | date_to_string }}</td>
37+
<td><a href="https://kit-downloads.studentrobotics.org/kit-software/{{ kit_version.version }}/srobo-robot-{{ kit_version.version }}.img.xz">Download <code>{{ kit_version.version }}</code></a></td>
38+
<td><a href="https://kit-downloads.studentrobotics.org/kit-software/{{ kit_version.version }}/srobo-robot-{{ kit_version.version }}-licences">Licences</a></td>
39+
</tr>
40+
{% endfor %}
41+
</table>
42+
</div>
43+
</div>
44+
</div>

kit/brain_board.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -17,23 +17,21 @@ The SD card is located on the underside of the board. Carefully open the Brain B
1717

1818
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.
1919

20-
To update the SD card, you'll need to download our image, [`srobo-robot-2022.0.0.img.xz`][robot-image].
20+
To update the SD card, you'll need to download our image from the [updates page]({{ site.baseurl }}/updates/).
2121
The flashing procedure is identical to flashing Raspberry Pi images.
2222

23-
[robot-image]: https://kit-downloads.studentrobotics.org/kit-software/2022.0.0/srobo-robot-2022.0.0.img.xz
24-
2523
## Etcher
2624

2725
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.
2826

2927
![Etcher example]({{ site.baseurl }}/images/content/kit/etcher.png)
3028

3129
<div class="info" markdown="1">
32-
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/).
30+
If you choose to use a tool other than Etcher, you may need to extract the `.img.xz` to `.img`. There are many tools available for this, e.g. [7-zip](http://www.7-zip.org/).
3331
</div>
3432

3533
### Flashing
3634

37-
1. Open Etcher and select the `srobo-robot-2022.0.0.img.xz` file you downloaded
35+
1. Open Etcher and select the `.img.xz` file you downloaded
3836
2. Select your SD card from the devices window
3937
3. Click 'Flash!'

updates/index.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
---
2+
layout: updates
3+
title: Updates
4+
kit_versions:
5+
- version: 2022.0.0
6+
released: 2021-11-13
7+
---
8+
9+
# Updates
10+
11+
Keeping your kit up to date is very important. It enables us to deploy new features, as well as fix bugs.
12+
13+
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.
14+
15+
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.
16+
17+
The following table outlines the updates which have been published.

0 commit comments

Comments
 (0)