Skip to content

Commit 288fca9

Browse files
committed
Add update check overlay
1 parent dc09205 commit 288fca9

File tree

6 files changed

+74
-3
lines changed

6 files changed

+74
-3
lines changed

_assets/css/site.css

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

_assets/less/site.less

+4-2
Original file line numberDiff line numberDiff line change
@@ -213,9 +213,11 @@ footer {
213213
.navbar-search .search-query { line-height: inherit; }
214214

215215
.blacklist-table,
216-
.notice-table {
216+
.notice-table,
217+
.overlay-table {
217218
.blacklist-plugin,
218-
.notice-plugin {
219+
.notice-plugin,
220+
.overlay-plugin {
219221
width: 50%;
220222
}
221223
.blacklist-versions,

_data/update_check_overlays.yaml

+18
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# Update check overlays, in case of maintainer change or a broken config etc. Format:
2+
#
3+
# pluginID:
4+
# user: new github user
5+
# repo: new github repo
6+
# pip: new pip URL
7+
# ...
8+
#
9+
# Any keys from the software update config can be overwritten, changing the default values. config.yaml on the
10+
# instances out there still wins though, in case the user has a personal override configured.
11+
octoprint:
12+
user: OctoPrint
13+
detailedprogress:
14+
user: tpmullan
15+
filamentmanager:
16+
user: OllisGit
17+
klipper:
18+
user: AliceGrey

_includes/navigation.html

+1
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@
2929
<ul class="dropdown-menu">
3030
<li><a href="{{ '/blacklist/' | prepend: site.baseurl }}">Blacklist</a></li>
3131
<li><a href="{{ '/notices/' | prepend: site.baseurl }}">Notices</a></li>
32+
<li><a href="{{ '/overlays/' | prepend: site.baseurl }}">Overlays</a></li>
3233
</ul>
3334
</li>
3435
</ul>

overlays/index.html

+46
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
---
2+
layout: page
3+
title: Config overlays
4+
---
5+
6+
<h2>Update check overlay</h2>
7+
8+
<p>
9+
Starting with version 1.5.0 OctoPrint now supports the use of a centralized update check overlay, to allow for
10+
setting new software update configs for plugins that e.g. were abandoned by their original maintainer and have been
11+
adopted by a new one at a new repository location, or plugins that shipped with a broken default update config.
12+
</p>
13+
<p>
14+
The overlay is hosted here on <code>plugins.octoprint.org</code> as a <a href="/update_check_overlay.json">JSON file</a>
15+
and currently contains the following entries:
16+
</p>
17+
<table class="table overlay-table">
18+
<thead>
19+
<tr>
20+
<th class="overlay-plugin">Plugin</th>
21+
<th class="overlay-data">Overlay</th>
22+
</tr>
23+
</thead>
24+
<tbody>
25+
{% for item in site.data.update_check_overlays %}
26+
<tr>
27+
<td class="overlay-plugin">
28+
{% assign id = item[0] | prepend: "/plugins/" %}
29+
{% assign p = site.plugins | where: "id", id | first %}
30+
{% if p %}
31+
<a href="{{ p.url }}">{{ p.title }}</a>
32+
{% else %}
33+
<code>{{ item[0] | xml_escape }}</code>
34+
{% endif %}
35+
</td>
36+
<td class="overlay-data">
37+
<div class="language-json highlighter-rouge">
38+
<div class="highlight">
39+
<pre class="highlight">{{ item[1] | jsonify }}</pre>
40+
</div>
41+
</div>
42+
</td>
43+
</tr>
44+
{% endfor %}
45+
</tbody>
46+
</table>

update_check_overlay.json

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
---
2+
layout: null
3+
---
4+
{{ site.data.update_check_overlays | jsonify }}

0 commit comments

Comments
 (0)