Folien von session TYPO3 camp Berlin 2019 über TYPO3 documentation contribution

1. DOCUMENTATION
Sybille Peters
sybille.peters@typo3.org
@T3DocTeam
@sypets
TYPO3 Camp Berlin 2019
#t3cb

2. 1. Das Team
2. Wer schreibt Doku?
3. Was ist TYPO3
Doku?
4. Wie ist sie
aufgebaut?
5. Contributen - Wer,
wie, was, warum?
AGENDA
25.06.2019 2Sybille Peters

3. DAS TEAM
3

4. DOCUMENTATION TEAM
 Martin Bless
 Daniel Siepmann
 Sybille Peters
4
25.06.2019 Sybille Peters
https://typo3.org/community/teams
/documentation

5. DAS TEAM: KONTAKT
 Slack: #typo3-documentation
 Twitter: @T3DocTeam
 (Email: documentation@typo3.org)
5
25.06.2019 Sybille Peters
https://typo3.org/community/teams
/documentation

6. DAS TEAM: AUFGABEN (1)
 Technische Infrastruktur:
– Docker Image
– Theme
– ...
6
25.06.2019 Sybille Peters

7. DAS TEAM: AUFGABEN (2)
 Doku über Doku schreiben
 Pull requests mergen
 Support: Slack channel #typo3-
documentation
 Kommunikation: news, Twitter
 Slack calls, Sprints
7
25.06.2019 Sybille Peters

8. WER SCHREIBT
DOKU?
8

9. ?
9

10. TYPO3
COMMUNITY!
10

11. WER SCHREIBT DOKU?
11
25.06.2019 Sybille Peters

12. WER SCHREIBT DOKU?
Früher:
 Doku Team
Heute:
 Core Contributor: Changelog
 Core Team updatet TYPO3 Explained, Referenzen etc.
 Community …
Alle können etwas beitragen!
12
25.06.2019 Sybille Peters

13. WAS IST TYPO3
DOKUMENTATION?
13

14. WAS IST TYPO3 DOKUMENTATION?
 Alles auf https://docs.typo3.org
 Offizielle Doku / community Doku
14

15. WAS IST TYPO3 DOKUMENTATION?
Offizielle Doku:
 Tutorials
 Guides
 References
 Changelog
 System Extension
Doku
 ...
15

16. WAS IST TYPO3 DOKUMENTATION?
Community Doku:
 Third Party
Extension
Dokumentation
16

17. WAS IST TYPO3 DOKUMENTATION?
 Einheitliches Format:
reStructuredText
 Einheitliche Struktur
 Automatisches Rendering (Webhook,
Intercept)
 Einheitliches Layout
17

18. TYPO3 DOKU
IST OPEN
SOURCE!
18

19. WIE IST TYPO3
DOKU
AUFGEBAUT?
19

20. WIE IST TYPO3 DOKU AUFGEBAUT?
 1x Homepage („glue pages)
 Handbücher (Tutorials, Guides, etc.)
20

21. WIE IST TYPO3 DOKU AUFGEBAUT?
 1 Handbuch → 1 GitHub Repository
21
https://github.com/TYPO3-Documentationhttps://docs.typo3.org/m/typo3/reference-tca/master/en-us/

22. WIE IST TYPO3 DOKU AUFGEBAUT?
.
├── composer.json
└── Documentation
├── Index.rst
├── Settings.cfg
└── ...
22

23. WIE IST TYPO3 DOKU AUFGEBAUT?
23
 .rst : reStructuredText
 Text mit markup
 Texteditor, IDE
 ReStructuredText plugin PhpStorm

24. WIE IST TYPO3 DOKU AUFGEBAUT?
24
DocTitle
└── Topic 1
└── Subtopic 1.1
└── Subtopic 1.1.1
└── Topic 2

25. WIE IST TYPO3 DOKU AUFGEBAUT?
25

26. WIE IST TYPO3 DOKU AUFGEBAUT?
Mehr zu reStructuredText
 Writing Documentation
→ Common Pitfalls
→ Cheat Sheet
26

27. WIE IST TYPO3 DOKU AUFGEBAUT?
Was ist mit Markdown?
 Wird auch unterstützt
 Offizielle Doku: nur reST
 Writing Documentation
→ Conventions → Formats
27
https://docs.typo3.org/m/typo3/docs-how-t
o-document/master/en-us/GeneralConve
ntions/Format.html

28. WIE IST TYPO3 DOKU AUFGEBAUT?
Was ist mit Markdown?

28
https://docs.typo3.org/m/typo3/docs-how-to-document/master/en-us/GeneralConventions/DirectoryFilenames.html

29. CONTRIBUTE
WARUM?
29

30. ?
30

31. CONTRIBUTE – WARUM?
 Wie gut ist die Doku?
 Wie aktuell ist die Doku?
 Wie gut verständlich ist die Doku?
31

32. TYPO3
BRAUCHT
GUTE DOKU
32

33. CONTRIBUTE – WARUM?
Vorteile: Gute Dokumentation
 Weniger Zeit f. Einarbeitung
 Leichteres Onboarding f. Mitarbeiter
 Mehr TYPO3 Entwickler
 Weniger Frust
33

34. CONTRIBUTE – WARUM?
Vorteile: Contribution
 Bessere Doku für alle
 Lernen (git, reST, GitHub, Docker,
schreiben, erklären)
34

35. CONTRIBUTE – WARUM?
35
COMMUNITYCOMMUNITY

36. CONTRIBUTE
WAS?
36

37. ?
37

38. CONTRIBUTE – WAS?
 Lesen!
 Feedback!
 Verbessern!
38

39. CONTRIBUTE – WAS?
Was ist besser?
 GitHub Issue schreiben?
 Oder Problem selbst lösen?
39

40. EIN BEHOBENES
PROBLEM IST
EINS WENIGER
40

41. CONTRIBUTE – WAS?
Feedback
 Fehler → Issue schreiben
 Slack Channel #typo3-
documentation
 Twitter: @T3DocTeam
41

42. CONTRIBUTE – WAS?
GitHub Issues
 Zu jedem Handbuch gehören Issues
 Problem in einem Handbuch → Issues
zu dem Repo (Related Links)
42https://github.com/TYPO3-Documentation

43. CONTRIBUTE – WAS?
Allgemeine Probleme
 In Slack #typo3-documentation
melden
 In Team repo:
https://github.com/TYPO3-Document
ation/T3DocTeam/issues
43

44. CONTRIBUTE – WAS?
 Mehr Info: „Writing Documentation“
→ „How You Can Help“
44

45. CONTRIBUTE
EINFACH
ANFANGEN
45

46. CONTRIBUTE - EINSTIEGSPUNKTE
 TYPO3 Blog:
 Writing
Documentation:


46

47. DEMO ...
47

48. DANKE!
48