Skip to content

Commit

Permalink
Kleine Korrekturen & gendergerechte Sprache 🏳️‍🌈
Browse files Browse the repository at this point in the history
Kapitel »Einleitung«

* REDAXO groß geschrieben
* Bindestriche ergänzt
* Absatz über FOR etwas umgeschrieben
* Versucht, etwas gendergerechter zu formulieren :)
  • Loading branch information
schuer committed Aug 27, 2017
1 parent 40e1b36 commit 46a9898
Show file tree
Hide file tree
Showing 3 changed files with 31 additions and 28 deletions.
6 changes: 3 additions & 3 deletions aktualisierung.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,16 +6,16 @@
<a name="hinweise"></a>
## Hinweise

REDAXO bietet eine komfortable Aktualisierungsmöglichkeit sowohl für das Core System selbst als auch für AddOns.
REDAXO bietet eine komfortable Aktualisierungsmöglichkeit sowohl für das Core-System selbst als auch für AddOns.

**Wichtiger Hinweis:** Wenn Aktualisierungen am System oder an AddOns vorgenommen werden, sollte in jedem Fall vorher eine komplette Sicherung des Systems gemacht werden. Hierzu muss die Datenbank gesichert werden. Dies kann entweder über das Addon Backup oder über eigene Datenbanktools (z.B. phpmyAdmin oder adminer) erledigt werden. Bei AddOns kann es auch sinnvoll sein, die Dateien des AddOns selbst zu sichern.
**Wichtiger Hinweis:** Wenn Aktualisierungen am System oder an AddOns vorgenommen werden, sollte in jedem Fall vorher eine komplette Sicherung des Systems gemacht werden. Hierzu muss die Datenbank gesichert werden. Dies kann entweder über das Backup-Addon oder über eigene Datenbanktools (z.B. phpmyAdmin oder adminer) erledigt werden. Bei AddOns kann es auch sinnvoll sein, die Dateien des AddOns selbst zu sichern.

Vor Aktualisierungen des Systems und AddOns sollten unbedingt die Versionshinweise beachtet werden. Möglicherweise werden bei einem Update Anpassungen am Code von Modulen, Templates oder anderen Addons notwendig.

<a name="aktualisierung"></a>
## Aktualisierung durchführen

Um die Aktualisierungen über den Installer durchzuführen, muss man als Administrator bzw. Benutzer mit Administratorrechten im System eingeloggt sein. Zum Installer gelangt man dann über den Menüpunkt [Installer](/{{path}}/{{version}}/installer). Dort werden alle AddOns aufgelistet, die über den Installer aktualisiert werden können.
Um die Aktualisierungen über den Installer durchzuführen, muss man als Administrator bzw. Person mit Administrationsrechten im System eingeloggt sein. Zum Installer gelangt man dann über den Menüpunkt [Installer](/{{path}}/{{version}}/installer). Dort werden alle AddOns aufgelistet, die über den Installer aktualisiert werden können.

Falls ein Update für den REDAXO-Core (Kernsystem) verfügbar ist, wird dies am Anfang der Liste angezeigt. Klickt man dort auf einen Eintrag, werden zunächst die Versionshinweise angezeigt. Ein Klick auf "Aktualisieren" aktualisiert das AddOn, bzw. das Core-System, und der Eintrag verschwindet aus der Liste.

Expand Down
8 changes: 4 additions & 4 deletions intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Die REDAXO-Dokumentation ist der Startpunkt für die Installation und Redaktion einer REDAXO-Webpräsenz. Zudem finden Developer hier auch die erforderlichen Informationen zur Entwicklung eigener Lösungen.

> Wir freuen uns sehr über Mitarbeit bei der REDAXO-Dokumentation. Derzeit arbeiten Peter Bickel, Thomas Skerbis und Wolfgang Bund an der Dokumentation.
Unterstützung wird immer benötigt; die Dokumentation wird in [GitHub gepflegt und erweitert](https://github.com/redaxo/docs), so dass sich jeder beteiligen kann. Neue Artikel oder Verbesserungen können gerne per Pull-Request oder Issues eingereicht werden.
Unterstützung wird immer benötigt; die Dokumentation wird in [GitHub gepflegt und erweitert](https://github.com/redaxo/docs), so dass sich alle beteiligen können. Neue Artikel oder Verbesserungen können gerne per Pull-Request oder Issues eingereicht werden.
[Zur Dokumentation auf GitHub](https://github.com/redaxo/docs).

Dokumentationen zu weiteren Versionen erreicht man über das Versionsauswahlmenü.
Expand All @@ -12,15 +12,15 @@ Dokumentationen zu weiteren Versionen erreicht man über das Versionsauswahlmen

**Einleitung**

Grundlegende Informationenen zur aktuellen Version, Aktualisierung, API
Grundlegende Informationenen zur aktuellen Version, Aktualisierung, API

**Setup**

Installationsanleitung, erster Login, Passwort-Wiederherstellung

**Anwender**
**Anwendung**

Der Anwenderbereich ist primär an die Redakteure gerichtet. Hier wird die Bedienung des Systems erläutert.
Der Bereich zur Anwendung ist primär an Redakteurinnen und Redakteure gerichtet. Hier wird die Bedienung des Systems erläutert.

**Basis**

Expand Down
45 changes: 24 additions & 21 deletions zusammenarbeit.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@
- [Slack-Channel](#slack-channel)
- [Forum](#forum)
- [Referenzen](#referenzen)
- [Friends of Redaxo](#friends-of-redaxo)
- [Friends Of REDAXO](#friends-of-redaxo)
- [Dokumentation](#dokumentation)
- [Fehler gefunden?](#fehler-gefunden)
- [Git Issues](#git-issues)
- [Git-Issues](#github-issues)
- [Pull requests](#pull-requests)
- [Eigene AddOns](#eigene-addons)
- [Redaxo Entwickler](#redaxo-entwickler)
- [REDAXO-Entwickelnde und Agenturen](#redaxo-entwickelnde)

<a name="mitarbeit"></a>
## Mitarbeit an REDAXO
Expand All @@ -20,22 +20,26 @@ REDAXO bietet als quelloffenes System viele Möglichkeiten der Mitarbeit. Eine M
<a name="slack-channel"></a>
## Slack-Channel

Erster Anlaufpunkt ist in jedem Fall der **FOR Slack Channel**, in dem sich Entwickler und Anwender austauschen. Für den Slack-Channel gibt es eine direkte Anmeldemöglichkeit beim [Slack-Anmeldeformular](/slack/).
Erster Anlaufpunkt ist in jedem Fall der **Slack-Channel von Friends Of REDAXO**, in dem sich Entwickelnde und Nutzer\_innen austauschen. Slack ist kostenlos und kann im Browser genutzt werden, es gibt aber auch Apps für alle wichtigen Systeme.

Für den Slack-Channel könnte ihr euch hier mit eurer E-Mailadresse anmelden: [Slack-Anmeldeformular](/slack/).

<a name="forum"></a>
## Forum

Das [Forum](/forum/) ist ebenso eine Möglichkeit, sich auszutauschen, Fragen zu stellen oder anderen Anwendern zu helfen.
Das [Forum](/forum/) ist ebenso eine Möglichkeit, sich auszutauschen, Fragen zu stellen oder anderen Anwenderinnen und Anwendern zu helfen.

<a name="referenzen"></a>
## Referenzen
## Website-Referenzen

Mit REDAXO erstellte Seiten können im Bereich [Referenzen](/cms/referenzen/) eingestellt werden.
Mit REDAXO erstellte Websites können im Bereich [Referenzen](/cms/referenzen/) eingestellt werden.

<a name="friends-of-redaxo"></a>
## Friends of Redaxo (FOR)
## Friends Of REDAXO (FOR)

Friends Of REDAXO ist eine Initiative von und für Entwickler\_innen, die eine **offene und gemeinschaftliche Zusammenarbeit** anstreben. FOR-Code wird immer unter der MIT-Lizenz veröffentlicht. Projekte werden von allen interessierten FOR-Mitgliedern abgestimmt und gemeinsam bearbeitet. Diejenigen, die ein Projekt gestartet haben, bleiben dabei in besonderem Maße verantwortlich. Sollten sie sich mal nicht mehr beteiligen wollen, wird das Projekt von anderen FOR-Mitgliedern aufgefangen und weiterentwickelt.

**Friends of Redaxo** ist eine Initiative von und für Entwickler, die eine offenere Zusammenarbeit anstreben. AddOns in diesem Bereich können grundsätzlich von jedem anderen FOR-Mitglied bearbeitet werden. FOR-Code wird immer unter der MIT-Lizenz veröffentlicht. Dennoch bleibt der Ersteller hauptverantwortlich für das AddOn, sofern er seine Verantwortlichkeit nicht abgeben möchte. Somit kann ein AddOn auch weiter entwickelt werden, selbst wenn der Hauptentwickler das AddOn nicht mehr weiter entwickelt. AddOns, die im FOR-Bereich veröffentlicht werden, kann man als vollständige Spende eines Entwicklers an die Community betrachten.
Die Arbeit von Friends Of REDAXO kann als Spende an die REDAXO-Community betrachtet werden.

<a name="dokumentation"></a>
## Dokumentation
Expand All @@ -45,33 +49,32 @@ Mitarbeit im Bereich Dokumentation ist ausdrücklich erwünscht. Auch hier gibt
<a name="fehler-gefunden"></a>
## Fehler gefunden?

Bei Fehlern ist zunächst zu prüfen, ob es sich um Implementierungsfehler oder Fehler im Code handelt. In jedem Falle ist eine möglichst aussagekräftige Beschreibung des Fehlers für den Entwickler hilfreich, um das Phänomen nachzustellen und darauf zu reagieren. In eine Fehlerbeschreibung gehören immer folgende Angaben:
Bei Fehlern ist zunächst zu prüfen, ob es sich um Implementierungsfehler oder Fehler im Code handelt. In jedem Falle ist eine möglichst aussagekräftige Beschreibung des Fehlers für die Entwickelnden hilfreich, um das Phänomen nachzustellen und darauf zu reagieren. In eine Fehlerbeschreibung gehören immer folgende Angaben:

- Welche Bedienungsschritte führen zu dem Fehler?
- Unter welcher Umgebung (PHP Version, Webserver, Provider, lokales System) tritt der Fehler auf?
- Unter welchem Browser und in welcher Version des Browsers tritt der Fehler auf?
- Unter welcher Umgebung (PHP-Version, Webserver, Provider, lokales System) tritt der Fehler auf?
- In welchem Browser und in welcher Version des Browsers tritt der Fehler auf?
- Was wurde zuletzt am System verändert (z.B. Installation von AddOns)?
- Wie macht sich der Fehler bemerkbar?

Die Fehlerbeschreibung kann um Errorlog-Meldungen ergänzt werden.

<a name="git-issues"></a>
## Git Issues
<a name="github-issues"></a>
## GitHub-Issues

Der Core von REDAXO und die meisten AddOns werden als Git-Repositories gepflegt. Dort lassen sich Fehler oder Wünsche in "Issues" eintragen. Bevor ein Issue eingetragen wird, empfiehlt sich folgendes Vorgehen: Zunächst prüft man, ob man die aktuellste Version des AddOns aus dem Git-Repository im Einsatz hat. Anschließend prüft man, ob das Issue bereits eingetragen oder bearbeitet wurde. Eine kurze Nachfrage im Slack-Channel, ob das gewünschte Feature oder der gefundene Fehler sinnvoll als Issue erfasst werden sollte, kann die Recherche ergänzen. Anschließend erstellt man im entsprechenden Repository das Issue.
Der Core von REDAXO und die meisten AddOns werden als GitHub-Repositories gepflegt. Dort lassen sich Fehler oder Wünsche in "Issues" eintragen. Bevor ein Issue eingetragen wird, empfiehlt sich folgendes Vorgehen: Zunächst prüfst du, ob du die aktuelle Version des AddOns aus dem Git-Repository im Einsatz hast. Anschließend prüfst du, ob das Issue bereits eingetragen oder bearbeitet wurde. Eine kurze Nachfrage im Slack-Channel, ob das gewünschte Feature oder der gefundene Fehler sinnvoll als Issue erfasst werden sollte, kann die Recherche ergänzen. Anschließend erstellst du im entsprechenden Repository das Issue. Vielen Dank für deine Mitarbeit!

<a name="pull-requests"></a>
## Pull Requests

Bei konkreten Codevorschlägen empfehlen sich "Pull Requests". Der Entwickler hat dann die Möglichkeit den Code zu prüfen und direkt zu übernehmen.
Bei konkreten Codevorschlägen empfehlen sich "Pull Requests". Die Entwickelnden haben dann die Möglichkeit, den Code zu prüfen und direkt zu übernehmen.

<a name="eigene-addons"></a>
## Eigene AddOns

Ein eigenes AddOn zu entwickeln ist immer eine Möglichkeit, sich aktiv an der Entwicklung zu beteiligen. Ist das AddOn für eine größere Anzahl von Anwendern von Interesse, kann dieses in den Downloadbereich eingestellt werden.

<a name="redaxo-entwickler"></a>
## Redaxo Entwickler
Ein eigenes AddOn zu entwickeln ist immer eine Möglichkeit, sich aktiv an der Entwicklung zu beteiligen. Ist das AddOn für eine größere Anzahl von Anwenderinnen und Anwendern von Interesse, kann dieses in den Downloadbereich eingestellt werden.

Im Loginbereich von REDAXO kann man sich selbst als Redaxo-Entwickler eintragen und wird dann auf der REDAXO-Website als Entwickler gelistet.
<a name="redaxo-entwickelnde"></a>
## REDAXO-Entwickelnde und Agenturen

Im Loginbereich von REDAXO (»MyREDAXO«) kannst du dich oder deine Agentur als REDAXO-Entwickelnde eintragen und wirst dann auf der REDAXO-Website im Bereich Support gelistet: [Agenturen](/support/agenturen/)

0 comments on commit 46a9898

Please sign in to comment.