How You Can Help¶
Everyone can contribute to the TYPO3 documentation and contributions are very much appreciated.
These are just examples to get you started. You are not restricted to this, as a contributor. If you can make useful improvements, do it! The best contributions come from starting with something that bothers you the most.
Make Minor Changes¶
If you see a typo, a broken link or can make some improvements in the spelling, do not hesitate to click on “Edit me on Github” and make the change yourself. See Workflow #1: “Edit me on Github” for a walkthrough.
Check spelling for consistency. For example, compare spelling of title and headlines to The TYPO3 Writing Style Guide on typo3.org.
Is spelling of proper nouns correct?
If you are a new contributor, you can look for issues in TYPO3-Documentation with the label “good first issue”:
- “good first issue”
- … or go to the Issues tab in Github and enter
is:open is:issue archived:false label:"good first issue" user:TYPO3-Documentationin the search field (this should get you the same result)
Using this link, you can get a list of all open, unassigned issues:
- Open, unassigned issues (without Documentation Team issues, without t3SphinxThemeRtd, without t3SphinxThemeRtdDemoDocs)
Pick an issue for a topic you are familiar with and try to fix it. Some of the issues address a problem, some are enhancements where new text needs to be written.
For more links to GitHub issues, see GitHub Issues.
You can also look at the open issues of a manual you are familiar with, pick one and fix the problem.
To find the issues for a specific manual click on “Related links” (on the bottom left of the page).
Replace Outdated Images¶
Replace outdated images, for example in the TSconfig Reference reference.
Look at Images for information about how to embed images with reST.
Add YouTube Videos¶
Add some new YouTube videos from the TYPO3 YouTube channel.
See Embed YouTube Videos for information on how to do this.
Add Information from the ChangeLog¶
Find information in the TYPO3 ChangeLog that is not yet documented and add it to a manual where the information is best documented, e.g.:
Teach and Motivate Others¶
If you are already familiar with the workflow, you can help others to get started. Whenever you are at a TYPO3 event (Sprint, Barcamp, etc.), on StackOverflow or in a Slack channel and someone finds something missing in the documentation, help them make the necessary changes themselves.
Thank others for their contributions (e.g. on Slack or personally).
Spread the Word¶
Tell others about things in the documentation, that are new and that you find interesting.
Remind people, that everyone can contribute!
Make Suggestions for New Content¶
Sometimes you can directly add content in a manual or create an issue for it.
But, what if you are not sure, where the new content should go or if it should be created at all?
If this is the case, either:
- Raise the question in the #typo3-documentation channel on Slack
- Or, add a comment with your suggestion to this general issue: What content is missing in the documentation?
Pick a manual (such as Getting Started Tutorial, TYPO3 Explained) and start reviewing it. If you find something that needs fixing or something is missing, either fix it or write an issue for it, if you cannot make the changes yourself.
Help to keep this list up to date: Review Status