Contao-Camp 2024
Ergebnis 1 bis 11 von 11

Thema: Contao Dokumentation

  1. #1
    Contao-Fan Avatar von intradesign
    Registriert seit
    28.07.2015.
    Beiträge
    338

    Standard Contao Dokumentation

    Moin zusammen,

    ich wollte gerne nochmal nachfragen, wie es um die Contao-Dokumentation steht und erneut meine Unterstützung anbieten. Über die Dokumentation wurde ja schon bei mehreren Veranstaltungen und hier im Forum gesprochen. Auch hat sich ja im letzten Jahr die Idee konkretisiert und es sah so aus, als würde etwas passieren. Allerdings kann ich nach wie vor nicht wirklich einen Fortschritt erkennen, weiß aber nicht, ob es daran liegt, dass ich nicht weiß, wo ich schauen muss, oder ob wirklich nichts passiert ist. Auf docs.contao.org jedenfalls ist vieles eher veraltet und/oder unvollständig.

    Mir ist klar, dass man in die Dokumentation viel Arbeit investieren muss. Ich möchte meinen Post deshalb nicht als Kritik verstanden wissen, sondern wie gesagt gerne erneut meine Mithilfe anbieten, weiß aber nicht, an wen ich mich wenden muss und wie ich mithelfen kann. Ich denke/hoffe, dass es anderen ähnlich geht.

    Deshalb hier mal ein paar Fragen:
    • Wie ist der Stand der Dinge?
    • Wo kann ich den Stand sehen?
    • Wer ist verantwortlich (und wen kann ich fragen)?
    • Wie kann ich dazu beitragen?
    • UND: Wer hat sonst noch Interesse, zur Dokumentation beizutragen und ist bereit, ein paar Stunden zu investieren?

    Für mich ist das Thema gerade wieder aktuell, weil es mit Contao 4.8 Änderungen und neue Funktionen gibt, die (aus meiner Sicht) nur sehr rudimentär in Tickets, Changelogs und der Ankündigung der Version angedeutet sind, deren praktische Anwendung allerdings oft nicht ausreichend dokumentiert ist. Bei einigen Funktionen macht das nichts, weil sie sich recht einfach im Backend nachvollziehen lassen (z.B. News-Listen mit hervorgehobenen Nachrichten zuerst), aber etwa Funktionen, die in Config-Dateien ausgelagert sind, finde ich immer nur sehr schwer nachvollziehbar – und nicht zentral dokumentiert (z.B. eine Auflistung ALLER in der config.yml zu machenden Einstellungen oder überhaupt eine Liste aller möglichen Config-Dateien und deren Aufgaben).

    Vielen Dank und viele Grüße
    Timo

  2. #2
    Contao-Urgestein Avatar von Franko
    Registriert seit
    22.06.2009.
    Beiträge
    1.503
    Partner-ID
    6122

    Standard

    Du kannst da mal @bjarke über slack ansprechen - Hab Ihn auch schon kontaktiert und Hilfe angeboten ...
    Freelancer, Digital Design Enthusiast, Contao Aficionado and Tutorial Junkie @MoinFranko - Carpe diem ...

  3. #3
    AG Pressearbeit
    Community-Moderator
    Buchautor 'Contao für Webdesigner'
    Avatar von planepix
    Registriert seit
    05.06.2009.
    Ort
    Stuttgart
    Beiträge
    6.464
    Partner-ID
    107
    Contao-Projekt unterstützen

    Support Contao

    Standard

    Hallo Timo,

    eine Zusammenfassung der Session zur Doku am Camp gibt es in den News:
    https://contao.org/de/veranstaltunge...camp-2019.html

    Beginnend mit dem Sonntag.
    ---------------------------------
    Beste Grüße planepix
    Contao für Webdesigner (Website), Twitter: @contaowebdesign
    weitzeldesign
    Contao-Sprechstunde
    Contao Schulungen: https://www.weitzeldesign.com/cms-co...chulungen.html
    Contao Jahrbuch: www.contao-jahrbuch.de
    Contao Agenturtag: www.contao-agenturtag.de
    Contao Stammtisch Stuttgart: www.contao-stammtisch-stuttgart.de
    Contao 4 Erfahrungen als Gitbook: https://app.gitbook.com/@planepix/s/...-mit-contao-4/
    Contao 4 & Manager Hosterhinweise: https://github.com/contao/contao-manager/wiki

    Schon wieder ein Update?
    Glücklich sind die, die den Wert erkennen – und wertschätzen.
    „Muss man machen wie beim Zahnarzt. Der bestraft einen auch mit hohen Rechnungen wenn man die Pflege vernachlässigt.”

  4. #4
    Community-Moderator
    Wandelndes Contao-Lexikon
    Avatar von Spooky
    Registriert seit
    12.04.2012.
    Ort
    Scotland
    Beiträge
    33.879
    Partner-ID
    10107

    Standard

    Hallo Timo

    Die neue Doku wird von mir, Fritz Michael Gschwantner, und Bjarke Ammann (netzarbeiter) geleitet und umgesetzt. Ich kümmere mich um die Entwickler Dokumentation während sich Bjarke um das neue Contao Handbuch kümmert.


    Zitat Zitat von intradesign Beitrag anzeigen
    Wie ist der Stand der Dinge?
    Es ist in Arbeit



    Zitat Zitat von intradesign Beitrag anzeigen
    Wo kann ich den Stand sehen?
    Derzeit noch gar nicht. Vor der Konferenz geht die neue Dokumentation online - voraussichtlich in einem Parallelbetrieb (um dann auch noch ein Weiterleitungskonzept von der alten Dokumentation entwickeln zu können).



    Zitat Zitat von intradesign Beitrag anzeigen
    Wie kann ich dazu beitragen?
    Sobald die Dokumentation vor der Konferenz veröffentlicht ist, kann jeder wie gewohnt dazu beitragen. Wird auch insgesamt einfacher als bisher sein.

  5. #5
    Contao-Fan Avatar von intradesign
    Registriert seit
    28.07.2015.
    Beiträge
    338

    Standard

    Prima, vielen Dank erst einmal für die Antworten.
    Ich bin schon sehr gespannt.

  6. #6
    Contao-Urgestein
    Registriert seit
    20.09.2012.
    Ort
    Lüneburger Heide
    Beiträge
    1.971
    Partner-ID
    12207
    User beschenken
    Wunschliste
    Contao-Projekt unterstützen

    Support Contao

    Standard

    Hallo Leute,

    an dieser Stelle möchte ich mal ein ganz dickes Lob an das "Doku-Team" richten.
    Sehr gute, hervorragende Arbeit.
    Übersichtlich und klar Strukturiert, sehr gut beschrieben und sogar mit sehr ordentlichem und zweckmäßigem Bildmaterial versehen.

    Hier mal die Links zur Doku:
    Auswahlseite: https://docs.contao.org/
    Deutsche Contao Doku: https://docs.contao.org/manual/
    Englisches Entwicklerhandbuch: https://docs.contao.org/dev/

    PS:
    Da darf man sich bestimmt gerne mal auf den "Wunschzetteln" der Ersteller "umsehen" -> done

    Gruß
    tschero
    Autodidakt und HobbyWebdesigner

    www.webdesign24.biz
    Screencasts zu Contao

  7. #7
    Contao-Urgestein Avatar von Franko
    Registriert seit
    22.06.2009.
    Beiträge
    1.503
    Partner-ID
    6122

    Standard

    Hallo,
    wenn man an der Doku mitarbeiten möchte evtl. noch folgendes.

    Die Infos auf https://github.com/contao/docs sind in erster Linie dazu gedacht die gesamte Doku lokal nachzubilden bzw. seine Änderungen dann auch direkt sehen/testen zu können bevor man diese einreicht.

    Hierzu muß dann zunächst hugo installiert sein. Also die entsprechenden binaries laden und im Anschluß im jeweiligen OS System Pfad einbinden. Die hugo Befehle sind dann global verfügbar ( Alternativ gibt es auch node wrapper hierzu - z.B.: https://www.npmjs.com/package/hugo-bin ).

    Auf das angesprochene Makefile ist man nicht zwingend angewiesen sollte "make" nicht installiert sein. Man kann auch die im Makefile enthaltenen hugo Befehle selbst ausführen:

    Code:
    cd page
    hugo server --cleanDestinationDir --environment manual --destination ../build/manual
    Grundsätzlich ist dies nicht notwendig ( aber hilfreich ) um an der Doku mitarbeiten zu können.
    Letztlich benötigt man lediglich einen GitHub Account dazu. Im Anschluß kann man die Markdown files z.B. auch direkt in GitHub ( https://github.com/contao/docs/tree/master/docs ) bearbeiten ( für kleinere Typo Korrekuren geht das sicherlich ). Nach dem Speichern wird der Pull Request angestoßen. GitHub erstellt dann autom. einen fork des Contao docs repository im eigenen Account mit einem neuen branch ala "patch-1".

    Das docs Team kann diese Änderungen dann einsehen und gegebenenfalls akzeptieren. Falls das Team hierzu Anmerkungen macht oder Änderungen verlangt könnt Ihr diese dann in dem branch ( e.g hier z.B. patch-1) eures fork machen. Ist der Pull Request dann geschlossen könnt ihr den temporären branch dann löschen ( oder das ganze fork repository ).

    Optional könnte man sich den fork auch clonen und dann lokal mit der IDE der Wahl arbeiten. Hierzu muß dann aber git installiert sein und entsprechende Kenntnisse im Umgang mit git vorhanden sein.
    Freelancer, Digital Design Enthusiast, Contao Aficionado and Tutorial Junkie @MoinFranko - Carpe diem ...

  8. #8
    Contao-Urgestein Avatar von Franko
    Registriert seit
    22.06.2009.
    Beiträge
    1.503
    Partner-ID
    6122

    Standard

    Ich brauche mal eure Hilfe,
    arbeitet jemand mit "Visual Studio Code" und der Extension "GitHub Pull Requests"?

    Hintergrund:
    Ich habe mir einen GitHub Fork erstellt und diesen lokal geclont.
    Ich mache nun meine Änderungen und aktualisiere dann das Fork repo. Klappt via Konsole o. direkt in VSC. Soweit schön.

    Möglichkeit 1):
    Ich mache über GitHub den Pull Request (PR).
    Wenn ich hierzu Anmerkungen bekomme bearbeite ich diese lokal und pushe wieder in meinem Fork.
    Innerhalb des PR wird dies realisiert und evtl. dann akzeptiert.

    Möglichkeit 2):
    Ich erhalte im PR Suggestions ( soweit im PR von mir erlaubt ).
    Diese Suggestions kann ich selbst im PR committen und werden dann auch entsprechend in meinem GitHub Fork repo übernommen. Das Contao Docs Team könnte dann dies akzeptieren und mergen.
    Lokal pull ich mir dann meinen Fork um das ganze auch lokal wieder aktuell zu haben. Auch gut.

    Jetzt habe ich mir diese obige VSC Extension installiert.
    Innerhalb VSC kann ich darüber PR's absetzen (nachdem man zuvor das entsprechende upstream remote hinzugefügt hat) und kann nun innerhalb VSC die PR Comments und auch die PR Suggestions sehen/aktualisieren bzw. selbst setzen. Alles was ich diesbezüglich in VSC mache erscheint im GitHub PR und visa versa ...

    Und nun zur Frage:
    Ich sehe nun innerhalb VSC z.B. eine o. mehrere PR Suggetions weiß aber nicht wie ich nun hier (lokal) diese übernehmen/commit kann.
    Der jeweilige PR ist in VSC dann mit checkout markiert. Die jeweiligen Dateien mit "M". Und nu?

    Für Hinweise dankbar
    Frank
    Geändert von Franko (20.10.2019 um 09:57 Uhr)
    Freelancer, Digital Design Enthusiast, Contao Aficionado and Tutorial Junkie @MoinFranko - Carpe diem ...

  9. #9
    Contao-Urgestein Avatar von Franko
    Registriert seit
    22.06.2009.
    Beiträge
    1.503
    Partner-ID
    6122

    Standard

    Zitat Zitat von Franko Beitrag anzeigen
    Und nun zur Frage:
    Ich sehe nun innerhalb VSC z.B. eine o. mehrere PR Suggetions weiß aber nicht wie ich nun hier (lokal) diese übernehmen/commit kann.
    Der jeweilige PR ist in VSC dann mit checkout markiert. Die jeweiligen Dateien mit "M". Und nu?
    Ok, mein Fehler.
    Ich hatte die Suggestions zuvor bereits innerhalb des GitHub PR commited. Dies wird dann in meinem GitHub Fork entsprechend abgebildet.
    Lokal dann nur wieder den origin master aktuell halten ( git pull ) ...
    Freelancer, Digital Design Enthusiast, Contao Aficionado and Tutorial Junkie @MoinFranko - Carpe diem ...

  10. #10
    Contao-Fan Avatar von Ernestopheles
    Registriert seit
    25.10.2019.
    Ort
    Hamburg
    Beiträge
    293
    Contao-Projekt unterstützen

    Support Contao

    Standard Wo werde ich Fragen zum Handbuch am besten los?

    Moin,

    ich arbeite mich gerade zur Einarbeitung durch das Contao Handbuch, das ich extrem gut finde.

    Im Kapitel Einstellungen habe ich diverse Fragen, insbesondere verstehe ich die Geschichte mit der config.yml nicht.

    Wo stelle ich solche Fragen am besten?

  11. #11
    Administrator Avatar von xchs
    Registriert seit
    19.06.2009.
    Beiträge
    14.548
    User beschenken
    Wunschliste
    Contao-Projekt unterstützen

    Support Contao

    Standard

    Fragen kannst Du hier im Forum stellen oder auch im Slack Channel #docs.
    Contao Community Administrator

    [Unterstützungsmöglichkeiten]

Aktive Benutzer

Aktive Benutzer

Aktive Benutzer in diesem Thema: 1 (Registrierte Benutzer: 0, Gäste: 1)

Lesezeichen

Lesezeichen

Berechtigungen

  • Neue Themen erstellen: Nein
  • Themen beantworten: Nein
  • Anhänge hochladen: Nein
  • Beiträge bearbeiten: Nein
  •