[go: up one dir, main page]

The TYPO3 Documentation Team

Our main goal is comprehensive, relevant, up-to-date and easy to find documentation about TYPO3 products for all users.

The Documentation Team sets the stage for you - the community - to write great documentation. Though we do love to write and update documentation, the purpose of our team is to provide the TYPO3 community with the tools to improve documentation.  

This includes information about using the tools to write great documentation. We strongly encourage the community to get involved. If you want to start right now, skip to the Contribute section on this page!

Contact us

The best way to contact the Documentation Team is in the Slack #typo3-documentation channel.

Register for Slack

Slack Calls

The Documentation Team uses regular Slack calls to talk about ongoing tasks. The meetings are announced in the Slack channel #typo3-documentation

Become Part of the Documentation Team!

The Documentation Team provides the infrastructure and support to help the TYPO3 community write great documentation.

  • Documentation is important to you?
  • You would like to work on improving the technical infrastructure?
  • You like to improve things?
  • You want to help us in any way?

 Good documentation is important. You can contribute!

Contact Us!

Lina Wolf

Leader

Florian Thiele

Co-Teamleader

Garvin Hicking

GitHub Administrator

Martin Bless

Member

Sarah McCarthy

Member

Stefan Frömken

Member

Sandra Erbel

Member

Jaap van Otterdijk

Member (Tooling, phpDocumentor)

Contribute

If you do not wish to officially join the Documentation Team just yet, you can still contribute to the documentation.

Read More About Documentation Contribution

Contribution Workflow

Did you know that contributing to the documentation has never been easier? That you are just one click away from starting a contribution yourself every time you visit a page on https://docs.typo3.org? Every official manual is contained in a GitHub repository and can be edited by anyone with a GitHub account. You can also edit a page directly on GitHub. All you need for that is a browser. If you are familiar with using Git and Docker, you can clone the repository and edit and render locally instead. 

Contribute now!

Ways to Contribute

There are several ways to contribute and things you can do as a contributor:

Past Achievements

You can browse through the Documentation Changelogs to see past achievements. But do note that a significant number of these achievements were contributed by community members who were not Documentation Team members. But that is a good thing because that is what we want to do: Involve you in creating great documentation.

Responsibilities of the Documentation Team

The Documentation Team provides the following:

  • Information about how to write documentation

  • Support via the Slack channel #typo3-documentation: Answer questions about writing documentation and using the tools

  • Support the TYPO3 CMS Core Team and other teams in their documentation efforts

  • Rendering of official manuals and extensions on the documentation server docs.typo3.org via automated toolchain

  • Docker image for local rendering

  • Theme

  • Organize sprints for working on documentation related tasks

  • Promote the work by writing news on typo3.org, tweeting and speaking at events

The following tasks were previously the responsibility of the documentation team and have now been redefined:

  • Translation of manuals: The Documentation Team can help others in matters concerning workflow and tools, but it concentrates its efforts on manuals in English.

  • https://wiki.typo3.org: The technical infrastructure is handled by the Server Team. Who will coordinate maintaining / migrating the content is yet to be defined.

  • https://api.typo3.org: The technical infrastructure is handled by the Server Team.

  • Writing content: Writing content must be a combined effort of the TYPO3 community.

  • Maintaining content: Content must continuously be updated and maintained. The long term goal is to put this in the hands of dedicated manual maintainers.

Documentation News

See also Documentation Changelogs on docs.typo3.org.

  • A fireman holding a cat.

    Become a TYPO3 First Responder at talk.typo3.org

    Categories: Community, Documentation, Education & Certification
    Created by Andreas Nedbal
    Everyone who asks a question at talk.typo3.org deserves a quick response, and we're looking for help with initial triaging. Make people feel welcome in the TYPO3 world — and it can require just half an hour a week.
    Read more
  • The letter M and a down-pointing arrow surrounded by a rounded rectangular frame on an orange background

    First Steps Towards Implementing CommonMark Markdown for TYPO3 Documentation

    Categories: Budget idea, Development, Association, Documentation
    Created by Florian Thiele
    As the TYPO3 Documentation Team, we’re excited to share the progress we’ve made so far on our current project: extending TYPO3’s documentation support to fully embrace CommonMark Markdown syntax.
    Read more
  • Screenshot of the TYPO3 documentation's Getting Started Tutorial home page

    Community Budget Idea Interim Report: Improving Documentation for New Integrators and Developers

    Categories: Budget idea, Community, Documentation
    Created by Björn Huber
    To assist newcomers to TYPO3, the initiative to improve documentation for new integrators and developers will update and restructure key resources to make them more accessible and easier to follow.
    Read more
  • Printing frame with letters spelling out the text "even a superhero has to go to bed"

    Transition to Full PHP-Based Rendering for All TYPO3 Extension Manuals

    Categories: Community, Documentation
    Created by Florian Thiele
    We are excited to announce that the TYPO3 Documentation Team is preparing to fully transition all extension manuals to the new PHP-based reStructuredText (reST) rendering system, and we will be shutting down the old Sphinx-based rendering in the near future.
    Read more
  • How to Streamline Your Data Exports with Download Presets in TYPO3 v13

    Categories: Demo, Development, TYPO3 CMS, Documentation
    Created by Tom Warwick
    Presets can be tailored to only include the columns you require for download. Plus, it can be shared with other backend users so that they have the ability to run the export themselves. Watch our latest video.
    Read more
  • Mass Editing Columns in TYPO3 v13

    Categories: TYPO3 CMS, Documentation, Development
    Created by Tom Warwick
    Discover how to easily view and apply mass edits to multiple pages within the page tree. You'll also learn how to efficiently view and update metadata for a collection of images in the Filelist.
    Read more
  • Printing frame with letters spelling out the text "even a superhero has to go to bed"

    Transition to PHP-Based reStructuredText Rendering for TYPO3 Documentation

    Categories: Documentation
    Created by Florian Thiele
    The TYPO3 Documentation Team is excited to announce the transition to a new PHP-based reStructured Text (reST) rendering engine for TYPO3 documentation. This shift, from the previous Sphinx-based system, promises significant improvements in speed, ease of use, and accessibility for contributors.
    Read more
  • A grid of avatars.

    Annual Report of the TYPO3 Documentation Team, 2023

    Categories: Community, Documentation, Documentation
    Created by Florian Thiele
    The TYPO3 Documentation Team underwent dynamic changes throughout 2023, fostering resilience and innovation in maintaining and enhancing the project's documentation.
    Read more
  • Report From a Three-Day Code Sprint By an Application Development Apprentice

    Categories: Event Report, Community, Documentation
    Created by Florian Thiele
    I joined the TYPO3 Community Sprint held in Düsseldorf 20–22 November 2023. This was my first time attending one of these events in person. Until now, my only experience was an online Community Sprint back in July. It was cool and kinda exciting to meet all these TYPO3 folks face-to-face.
    Read more
  • You’re Invited: Best Practices Team Remote Sprint

    Categories: Development, Community, TYPO3 CMS, Documentation
    Created by Daniel Siepmann
    The Best Practices team's inaugural remote sprint is happening on 27 November 2023. We'll meet on Slack for a day of general housework and working through our backlog.
    Read more