Hilfe-Seite/Dokumentation

fehlt bisher komplett.

• Für das "neue" NetVS sollte eine Grundlegende Benutzer-Doku angelegt werden. Könnte angelehnt werden an die noch ausstehende ITB-Schulung zur Benutzung des NETVS.
• Glossar für Begriffe in NetVS / WebAPI. Existiert in Teilen schon hier
• FAQ aufbauen

changed milestone to %KIT-weiter Test

changed title from Hilfe-Seite to Hilfe-Seite/Dokumentation

changed the description

Bin gerade dabei, die Hilfe vom alten DNSVS auseinander zu nehmen. Teile davon kann man ja auf jeden Fall übernehmen.

einfach, aber sehr wirkungsvoll: bitte den doku-link

(https://www-net-doku.scc.kit.edu/webapi/release/dnscfg-perms/)

mit in die netvs-links (API, Fehler melden, Kontakt) aufnehmen. titel: z.b. Dokumentation/Hilfe und am besten auch in die fehlermeldung unter einem titel wie z.b. "Fehlermeldung nicht verstanden? -> Doku/Begriffserklaerungen" platzieren.

ich moechte bei rueckfragen, die sich durch lesen der doku beantworten lassen wuerden, dem benutzer einen verweis auf die doku geben koennen. solange aber im netvs keiner ist, geht das schlecht.

Erledigt in 36ee7537

closed

der link fehlt immernoch in der link-gruppe unten auf der netvs-eingangsseite und dnsvs-hauptseite. unter dem stichwort '</> API' wird keiner eine netvs-hilfe vermuten und suchen. oder soll ich anfragen/tickets, die durch lesen der hilfe-seite beantwortbar waeren, an dns-betrieb weiterleiten?

reopened

Nochmal: Bug gecshlossen != auf Prod aktiv. Siehe branch des commits. Wenn du es anschauen willst: Schau auf https://netvs-devel-devel.scc.kit.edu.

closed

ja, dort stimmt es. aber was heisst 'nochmal' und warum ist es auf prod nicht aktiv? ich weiss auch nicht, was ich in 'siehe branch des commits' sehen soll. soll ich in deinem code danach suchen?

Zu 'nochmal': Hatte ich schonmal in einer Mail gecshrieben ;)

Warum es auf prod nicht aktiv ist: Weil ich eigentlich an prod nurnoch hotfixes mache. Die Hauptentwicklung findet im new_interface branch statt.

Branch des Commits: Weiter oben steht ein Kommentar "Erledigt in 36ee7537". Wenn man auf dem commit klickt sieht man, dass das im new_interface branch ist und der um weiten ahead von master ist. Ok? :)

naja, diese ableitungen sind fuer mich nicht so offensichtlich. dass ein devel-branch soundso weit voraus ist, ist an sich klar. so eine aenderung geht halt nicht ohne doppelte codepflege.

Ist die Dringlichkeit davon so hoch, dass es einen hotfix rechtfertigt, oder kann es auch noch die paar Wochen/Monate warten, bis das neue Interface eingesetzt wird?

dringlichkeit - das klingt ja so, als waere es ein mords-aufwand. ich glaube, allein der aufwand, diese diskussion zu fuehren, ist deutlich hoeher (insbesondere, wenn du es gleich zu beginn vor 4 monaten gemacht haettest). es ist leider doppelte codepflege, und ich muss mich auch ab und zu damit rumplagen. laesst sich aber nicht immer ganz vermeiden.

ich finde, es vermittelt einen schlechten eindruck, auf benutzeranfragen/tickets den leuten jedesmal nachtraeglich den doku-link explizit zu schicken. sie werden sich berechtigterweise fragen, warum es ihn im netvs nicht schon gibt. ausserdem geraet man damit etwas in die postion eines bittstellers (bitte lesen Sie erstmal die doku. ja - es gibt zwar eine, aber wir koennen den link nicht offenlegen).

also wenn devel-devel definitiv diesen oder naechsten monat produktiv geht, einverstanden. ich glaube aber sehr, dass es laenger dauern wird - deshalb behaupte ich, dass es in diesem sinne dringlich ist.

noch als anmerkung: das link-ziel ist eigentlich auch nur ein doku-provisorium, um erstmal ueberhaupt irgendwas zu haben. genaugenommen gehoert hier als bestandteil der grundausstattung eine dokumentation hin, die rein netvs-webintf.-bezogen ist (nicht webapi-bezogen) und auch fuer 'unbedarftere' itbs verstaendlich ist. das sollte eigentlich aus dem ursprungstitel dieser issue hervorgehen.

ack

doku schreiben ist ja meistens keine besonders angenehme aufgabe... falls du mal noch unterstuetzung f.d. 'echte' netvs-doku brauchst (aufbau, texte, formulierugen, etc), bin ich bereit. wir haben ja auch noch als vorlage die alte dnsvs-hilfeseite.

reopened

mentioned in commit 0822ec3a

changed the description

By nk2202 on 2020-11-23T19:29:40 (imported from GitLab)

removed 1 deleted label

added documentation label

assigned to @nk2202

By nk2202 on 2020-11-23T19:34:51 (imported from GitLab)

marked this issue as related to #202 (closed)

By nk2202 on 2020-11-23T19:35:35 (imported from GitLab)

changed the description

By nk2202 on 2020-11-23T19:40:06 (imported from GitLab)