Autoren für die Doku, Wiki und Webdesigner gesucht

[awknx]

So, ich kann jetzt im Wiki auch editieren - es lag an GitHub selbst, die haben das jetzt geklärt. Wie ist das gedacht von Euch - schreibt jeder wild drauf los und direkt ins Wiki oder koordiniert jemand?
Es gibt ja durchaus unterschiedliche Vorstellungen für die Strukturierung und es wäre sicher sinnvoll gleich von Anfang an einen einheitlichen Aufbau (=Menü) zu haben.

Zum Thema Beispiele hatte ich ja schon was geschrieben, ich finde es z.B. auch sinnvoller statt

Konfiguration -> Items -> Systemitems -> Beispiel Systemitems Tag/Nacht

dann lieber

Konfiguration -> Items -> Beispiele -> Systemitem Tag/Nacht

zu gliedern und dann unter Beispiele (hoffentlich) weitere Beispiele einzuordnen.

Letztlich halte ich mich aber natürlich an gewünschte Vorgaben der hier federführenden Mitglieder :-) und würde dann langsam mal loslegen.

[psilo]

also mind. finde ich den menüeintrag für rechts zu lang..
fsdf.PNG
mir gefällt die dritte Ebene schon grundlegend nicht. Das sollte lieber auf den Seiten der 2ten ebene gelinkt werden, nicht im Menü.

Zur Gliederung würde ich wenn dann sowas wie "Grundlagen", "Beispiele", "..." befürworten. Unter Beispiele hätte ich aber eher konkrete Beispiele bspw. für beliebte Plugins wie KNX (Licht, Rolläden usw) gesehen. Die Systemsachen sind halt Teil des Kerns und mE separat weil ohne Plugin nutzbar. Oder man gliedert die Beispiele halt auch wieder auf.

Was meinen die anderen.

[awknx]

So wäre z.B. kürzer:

Konfiguration -> Items -> Beispiele -> Tag/Nacht

Ich würde aber schon ein dreistufiges Menü machen, sonst wird es ja auch am Ende eine lange Liste.

[Boomer55]

Hallo zusammen.

Bezüglich vorangehend diskutiertem "Negativbeispiel" über Tag/Nacht muss ich mich wohl zu meiner Tat bekennen.
Grundsätzlich ging es mir erst auch nur mal darum, dass Einsteiger die Seiten erstmal überhaupt finden.

Es gibt derzeit 75 Seiten im Wiki von denen nur ein Teil irgendwo verlinkt oder vereinzelt sogar veraltet sind. Ein Einsteiger tut sich damit sicherlich schwer zwischen wichtiger, richtiger und veralteter Information zu unterscheiden.

Wie schon erwähnt, bin ich "leider" nur Anwender und kann daher nur bei der Dokumentation unterstützen. Vielleicht ist diese Tatsache jedoch gar nicht mal so schlecht um eine zugängliche Dokumentation für Nicht-Profis auf die Beine zu stellen.

Ich unterstelle mal dem Großteil des derzeitigen Projektteams sehr große Kompetenz was die Programmierkenntnisse anbelangt. Jedoch denke ich auch, dass dadurch grundlegende Dinge und Details in der Doku (die für euch Profis normal sind) vergessen werden und dann für einen Einsteiger eine unüberwindbare Hürde darstellen.

Daher würde ich auch gerne an der Dokumentation weiterarbeiten. Gerne auch im Auftrag wenn gewünscht.
Frei nach dem Motto: " Jeder nach seinen Stärken und Fähigkeiten" ;-)

Beste Grüße aus Österreich,
Markus

[awknx]

So schlimm ist's jetzt auch wieder nicht :-)

Aber ich bin auch deiner Meinung (nach meinen ersten qualvollen Schritten), dass eine gute zugängliche Doku in "Laiensprach" viel helfen wird. Je leichter man den Einstieg findet, desto eher entscheidet man sich dann auch, dabei zu bleiben und das wird die Popularität erhöhen. Letztlich haben wir alle vermutlich ja am Anfang erst mal die gängigen verfügbaren Systeme angeschaut (OpenHab, FHem...) und uns dennoch für smarthome.py mehr erwärmt.

Und ich finde es wichtig, genau jetzt den Rahmen möglichst sauber abzustecken, bevor wir alle wild drauflos dokumentieren ;-)

Und ebenfalls viele Grüße nach Österreich
Andi

[awknx]

Ist das Wiki schon weiter wie das SmarthomeNG?

Beispiel aus https://github.com/smarthomeNG/smarthome/wiki/env
env.location.sunrise.elevation.degrees 2016-08-09 15:13:48,760 WARNING Zentral.Astronomie.Sonne.Aufgang.Azimut Item Zentral.Astronomie.Sonne.Aufgang.Azimut: problem evaluating sh.env.location.sunrise.azimut.degrees(): 'Item' object has no attribute 'azimut' -- item.py:__run_eval:341

[bmx]

Im Wiki ist im Hinblick auf die Release-1.2 schon was drin denke ich. Da ich jetzt seit einigen Wochen produktiv auf der Release-1.2 fahre fällt mir sowas allerdings nicht auf. Vielleicht sollten wir bei Änderungen im Wiki mal die Version aufschreiben, für die das gilt...

[awknx]

Wäre nicht schlecht - ich bastel schon wieder seit Stunden an den astronomischen Berechnungen, weil die nicht wirklich nachvollziehbar agieren (zumindest für mich...).

[smai]

Wie wäre es, wenn wir oben in jeden Wiki-Artikel schreiben, ab welcher Version dieser gültig ist?

Wir könnten für die Darstellung z.B. den Blockquote missbrauchen (ergänzt um h3, damit es nicht zu unauffällig ist.
Damit hebt es sich vom eigentlichen Inhalt ab. Und der Blockquote wird sowohl in Markdown- wie auch in MediaWiki-Syntax gleich dargestellt.

Die Anleitung für frühere Versionen von SH liesse sich in der Revision History des Wiki aufrufen.
Damit diese besser aufgefunden wird, könnte man auch unterhalb der Version gleich den Link auf die die Seite in der History einfügen.

Hier ein Beispiel, wie das aussehen würde.

In Markdown lässt sich dies folgendermassen schreiben:

> ### Gültig ab SmartHomeNG 1.2

Und in MediaWiki-Syntax so:

=== <blockquote>Gültig ab SmartHomeNG 1.2</blockquote> ===

[awknx]

Ich sehe da nur das Problem, dass z.B. bei meiner Beispielseite ja ein Teil schon stimmt und anscheinend nur ein bestimmter Teil noch nicht. Man müsste also eher an der entsprechenden Stelle kennzeichen, ab wann es funktioniert.

[smai]

Jetzt zu Beginn ist halt das Problem, dass wie im Beispiel der env-Items gar keine frühere Version der Dokumentation existiert.
Bereits die erste Revision des Artikels bezieht sich auf die Features aus 1.2.

Für jeden Absatz die Version anzugeben fände ich aber übertrieben, die Lesbarkeit würde wohl ziemlich leiden.

Ich gehe davon aus, dass beim erstellen einer Wiki-Page der aktuelle Master-Branch oder ein neuerer Pre-Release berücksichtigt wird.
Es wird wohl kaum ein Wiki-Autor Lust haben, für jede Zeile zu überprüfen, ab welcher Version diese gilt.

[awknx]

Vielleicht ist es einfacher, jetzt die V1.2 einfach abzuwarten un deinen Vorschlag für künftige Releases zu berücksichtigen - dürfte ja die nächsten Tage kommen, oder?

[awknx]

Blöde Frage - ich habe gerade im Wiki das Menü erweitert und auch in den Punkt Astronomie angefangen, was reinzuschreiben und gespeichert. Wenn ich es jetzt aufrufe, sehe ich aber nichts...
... hat das was mit Rechten, Freigabe o.ä. zu tun?

Wie macht ihr das überhaupt - erst mal lokal alles schreiben und dann irgendwie übertragen (kenne mich mit GitHub im Grunde bisher nicht aus)?

[smai]

Hallo Andi

Der Titel einer Seite ist automatisch auch die URL.
Die Seite "Nutzung astronomischer Daten" hat also die URL https://github.com/smarthomeNG/smart...omischer-Daten
Ich habe deinen Menüeintrag entsprechend korrigiert.

Mit anderen Worten: Man darf den Titel einer Seite eigentlich nie ändern.

Beim Eintrag "Beispiele" habe ich den Link entfernt, weil dies ja gar keine Seite ist sondern nur eine Strukturierung des Menüs.

Gruss
Stefan

[awknx]

Okay, dann achte ich da jetzt drauf. Ich dachte, der Begriff hinter dem Menüeintrag macht dann die URL.