[1.15] Umgt-Dokumentation

Hier finden sich Fragen und Ergänzung zur Dokumentation. // All questions and discussions about the documentation.
Antworten
Benutzeravatar
dr.e.
Administrator
Beiträge: 4527
Registriert: 04.11.2007, 16:13:53

[1.15] Umgt-Dokumentation

Beitrag von dr.e. » 14.11.2011, 23:10:39

Hallo zusammen,

ich habe gerade begonnen, die Struktur der Umgt-Doku zu definieren. Ich habe folgenden Vorschlag mit der Bitte um Kommentare:
  • Einleitung
  • Konzepte
    • Benutzer
    • Gruppen
    • Sichtbarkeits-Berechtigungen
    • Funktions-Berechtigungen
  • Datenmodell
    • Bild
    • Beschreibung der Entitäten
    • Beschreibung der Domänen-Objekte
  • Aufbau des Moduls / Komponenten
  • Installation inkl. Backend
    • Sandbox
    • Plain
  • Bedienung / Funktion Backend
  • Entwicklung
    • Einsatz von fertigen Modulen
      • Login
      • Registrierung
      • User dep content
    • Einbau in eigene Applikationen (UmgtManager) / Anwendung
      • Beziehen des Managers
      • Login
      • Auslesen von Permissions
      • Anlegen von Benutzern
      • Anlegen von Gruppen
      • Anlegen von Sichtbarkeits-Berechtigungen
  • Passwort-Verschlüsselung
Viele Grüße,
Christian

Benutzeravatar
Screeze
Beiträge: 1920
Registriert: 05.08.2009, 09:49:04
Kontaktdaten:

Re: [1.15] Umgt-Dokumentation

Beitrag von Screeze » 14.11.2011, 23:19:34

Ich würde das ganze technische - Datenmodelle etc. - an den Schluss setzen.
Grund: Viele wollen das Modul wie es ist einfach zum laufen bekommen wenn sie die Doku suchen - wenn man dann gleich von Datenmodellen etc. erschlagen wird, ist das nicht so schön.
Wer sich tiefer mit beschäftigen will kann dann ja weiter unten nachlesen.

Benutzeravatar
dr.e.
Administrator
Beiträge: 4527
Registriert: 04.11.2007, 16:13:53

Re: [1.15] Umgt-Dokumentation

Beitrag von dr.e. » 14.11.2011, 23:23:11

Guter Hinweis, danke! Würdest du das Thema "Konzepte" auch weiter unten anstellen? IMHO eher nicht, denn du solltest schon verstanden haben, was Sichtbarkeits- und Funktions-Berechtigungen sind, wenn du in der GUI klickst.

Weitere Anmerkungen?
Viele Grüße,
Christian

Benutzeravatar
Screeze
Beiträge: 1920
Registriert: 05.08.2009, 09:49:04
Kontaktdaten:

Re: [1.15] Umgt-Dokumentation

Beitrag von Screeze » 14.11.2011, 23:32:52

Sofern die Konzepte verständlich als Erklärung dienen können sie da bleiben.

Benutzeravatar
dave
Beiträge: 903
Registriert: 04.02.2011, 19:03:57
Wohnort: Berlin
Kontaktdaten:

Re: [1.15] Umgt-Dokumentation

Beitrag von dave » 15.11.2011, 11:59:02

Mit Screeze´ Hinweis sieht das gut aus! Über das Datenmodell habe ich auch immer hinweg gescrollt. Am Anfang konnte ich eh damit nichts anfang, mittlerweile zwar schon aber ich will das UMGT ja nur "nutzen", nicht die geneue Arbeitsweise dahinter ergründen ;).

Benutzeravatar
dr.e.
Administrator
Beiträge: 4527
Registriert: 04.11.2007, 16:13:53

Re: [1.15] Umgt-Dokumentation

Beitrag von dr.e. » 04.01.2012, 22:49:25

Halll zusammen,

nicht, dass der Eindruck entsteht, hier passiere nichts. :) Die Doku hat mittlererweile 35 Seiten und kann in einer Preview unter

http://media.adventure-php-framework.or ... 5_beta.pdf

heruntergeladen werden. Sie wird künftig natürlich auch online erreichbar sein, jedoch erst dann, wenn sie abgeschlossen ist. Anregungen immer gerne. In der aktuellen Version fehlen natürlich noch einige Punkte. Dies sind:

Code: Alles auswählen

* Entwicklung
** Einsatz von fertigen Komponenten
*** Login
*** Registrierung
*** User dep content
** Einbau in eigene Applikationen (UmgtManager) / Anwendung
*** Beziehen des Managers
*** Login
*** Registrierung
*** Auslesen von Permissions
*** Anlegen von Benutzern
*** Anlegen von Gruppen
*** Anlegen von Sichtbarkeits-Berechtigungen
* Passwort-Verschlüsselung
* Datenmodell
** Bild
** Beschreibung der Entitäten
** Beschreibung der Domänen-Objekte
Feedback immer gerne!
Viele Grüße,
Christian

Benutzeravatar
ma2604121
Beiträge: 349
Registriert: 24.01.2011, 23:42:18

Re: [1.15] Umgt-Dokumentation

Beitrag von ma2604121 » 07.01.2012, 14:50:57

Sieht sehr gut, ausführlich und übersichtlich aus!

Benutzeravatar
dr.e.
Administrator
Beiträge: 4527
Registriert: 04.11.2007, 16:13:53

Re: [1.15] Umgt-Dokumentation

Beitrag von dr.e. » 07.01.2012, 21:19:58

Thx, dann werde ich in diesem Stil weiter verfahren. Einige Punkte sind noch nicht komplett sauber ausformuliert, sondern noch als "Merkersätze" verfasst, so dass die Formulierung auch an den fertigen Punkten noch verbessert wird.
Viele Grüße,
Christian

TipTop
Beiträge: 193
Registriert: 25.08.2011, 22:37:08
Wohnort: Klagenfurt, Österreich
Kontaktdaten:

Re: [1.15] Umgt-Dokumentation

Beitrag von TipTop » 08.01.2012, 12:25:13

ma2604121 hat geschrieben:Sieht sehr gut, ausführlich und übersichtlich aus!
Kann man nur zustimmen - gute Arbeit! :)

Könntset Du vielleicht noch ein Inhaltsverzeichnis hinzufügen?

Benutzeravatar
dr.e.
Administrator
Beiträge: 4527
Registriert: 04.11.2007, 16:13:53

Re: [1.15] Umgt-Dokumentation

Beitrag von dr.e. » 08.01.2012, 13:24:03

Hi Nico,

ein Inhaltsverzeichnis wird es wie gewohnt in der Sidebar geben. Allerdings erst, wenn ich die Doku auf der Seite veröffentliche.
Viele Grüße,
Christian

Benutzeravatar
dave
Beiträge: 903
Registriert: 04.02.2011, 19:03:57
Wohnort: Berlin
Kontaktdaten:

Re: [1.15] Umgt-Dokumentation

Beitrag von dave » 14.01.2012, 22:49:43

Ich habe auch einmal über die Doku hinweg gescrollt. Kann mich meinen Vorrednern nur anschliessen: Sieht sher gut und ausführlich aus! Alle weiteren Details werden, wie immer, nach und nach durch Anregungen folgen. Wir sollten da auch wie gewohnt verfahren ;)

Einzig was mich gleich zu Beginn etwas störte war:
Benutzer-Management
Entweder alles auf Deutsch -> Benutzer-Verwaltung
oder Englisch -> User-Management (was ja auch logisch passen würde) ;)

Benutzeravatar
dr.e.
Administrator
Beiträge: 4527
Registriert: 04.11.2007, 16:13:53

Re: [1.15] Umgt-Dokumentation

Beitrag von dr.e. » 15.01.2012, 16:04:09

Hi dave,

das habe ich schon ausgetauscht und nenne es "Benutzer-Verwaltung". :)
Viele Grüße,
Christian

Benutzeravatar
dr.e.
Administrator
Beiträge: 4527
Registriert: 04.11.2007, 16:13:53

Re: [1.15] Umgt-Dokumentation

Beitrag von dr.e. » 06.02.2012, 20:53:33

Hallo zusammen,

ich habe die Übersetzung des UMGT jetzt abgeschlossen. Dabei wurden auch einige veraltete/nicht mehr benötigte Code-Teile entfernt und Views optimiert. Ich fahre nun mit der Doku des UMGT-Moduls fort und präsentiere von Zeit zu Zeit weitere Ergebnisse.

Sollte jemand gerade etwas Zeit aufwenden können, wäre ich für Mithilfe dankbar.
Viele Grüße,
Christian

Benutzeravatar
dr.e.
Administrator
Beiträge: 4527
Registriert: 04.11.2007, 16:13:53

Re: [1.15] Umgt-Dokumentation

Beitrag von dr.e. » 21.05.2012, 23:26:20

Hallo zusammen,

ich habe nun etwa 60% der Doku fertig und werde diese für 1.15 auch nicht mehr zu 100% fertigstellen. Grund: sonst releasen wir 1.15 nicht schnell genug. In den Release-Notes habe ich bereits einen Hinweis eingebaut, dass die Dokumentation in 1.16 weiter vervollständigt wird.

Einwände?
Viele Grüße,
Christian

Antworten

Wer ist online?

Mitglieder in diesem Forum: 0 Mitglieder und 2 Gäste