Überarbeitung der Bee Observer Online Dokumentation

Bee Observer BOB Entwicklung
1

Einleitung

Auf Basis des Knowledge Explorer Plugin - plugin - Discourse Meta können die bereits vorhandenen Anleitungen und Dokumentationen für das Bee Observer Projekt besser aufbereitet und präsentiert werden.

Übersicht

Es gibt nun einige kanonische Einstiegspunkte, die über kompakte Links erreichbar sind, um sie möglichst einfach mitteilen zu können, zum Beispiel

Details

:fast_forward: Hinweis: Alle bei https://bee-observer.hiveeyes.org/ zusammengeführten Ressourcen sind nun über eine solche Vanity-URL erreichbar, z.B. auch die

Suche in der Knowledge Base

Die Suchfunktion im Knowledge Explorer beschränkt sich auf die Inhalte der designierten Kategorien – einwandfrei!

Beispiele

1 Like
2

Hinweise für Autoren der Dokumentation

Backlog

Folgende Dinge gilt es noch einzuarbeiten bzw. zu überarbeiten.

Erledigt

1 Like
3

Hallo in die Runde,

@clemens hat mich gerade darauf aufmerksam gemacht, dass einige Links auf der technischen Haupt-Anleitungsseite zum Bee Observer https://bee-observer.hiveeyes.org/ nicht mehr funktionierten, etwa Teileliste des Bee Observer Sensor-Kit - Docs - Hiveeyes.

Scheinbar sind hier beim Discourse Docs (Documentation Management) - plugin - Discourse Meta im Juli 2020 die Routen geaendert worden. Nachdem wir am 6. Dezember 2020 diese Updates eingespielt haben, ist das kaputtgegangen.

Das Plugin hoert nun nicht mehr auf /knowledge-explorer, sondern auf /docs.

Ich habe gerade die Konfiguration entsprechend angepasst.

/etc/nginx/sites-enabled/bee-observer.hiveeyes.org 
# Vanity URLs for https://bee-observer.hiveeyes.org/

# Site
rewrite  ^/$ https://community.hiveeyes.org/docs?topic=2823 break;
rewrite  ^/search/(.*)$ https://community.hiveeyes.org/docs?search=$1 break;

# General
rewrite  ^/bmbf-verbundprojekt https://community.hiveeyes.org/docs?topic=454 break;
rewrite  ^/faq https://community.hiveeyes.org/docs?category=68 break;

# Documentation
rewrite  ^/alle-anleitungen https://community.hiveeyes.org/docs?category=76 break;
rewrite  ^/construction-manual https://community.hiveeyes.org/uploads/short-url/gqPu0WT7T48ZFtFUu46CvgO1pEa.pdf break;

# Building
rewrite  ^/teileliste https://community.hiveeyes.org/docs?topic=2103 break;
rewrite  ^/aufbau-stockwaage https://community.hiveeyes.org/docs?topic=2457 break;
rewrite  ^/aufbau-temperaturrechen https://community.hiveeyes.org/docs?topic=2458 break;
rewrite  ^/setup-firmware https://community.hiveeyes.org/docs?topic=2673 break;

# Setup
rewrite  ^/inbetriebnahme https://community.hiveeyes.org/docs?topic=2443 break;
rewrite  ^/installation https://community.hiveeyes.org/docs?topic=2662 break;
/etc/nginx/sites-enabled/community.hiveeyes.org 
# Cool URIs don't change (2021-01-08)
# Adjust to new routes of Knowledge Explorer
# https://github.com/discourse/discourse-knowledge-explorer/commit/14861e33
rewrite  ^/knowledge-explorer(.*)$ https://community.hiveeyes.org/docs$1 break;

Vielen Dank fuer die Aufmerksamkeit, @clemens.

Herzliche Gruesse,
Andreas.

P.S.: Unabhaengig der auf https://bee-observer.hiveeyes.org/ angefuehrten Direktlinks gibt es auch eine generische Suchadresse, die ganz einfach z.B. per Docs - Hiveeyes genutzt werden kann.

4