Kategorier: Alla - pipeline - framework - repositories - documentation

av François Suter för 12 årar sedan

563

ReST Migration

The document discusses the process and components involved in managing and rendering TYPO3 documentation, highlighting the transition from OpenOffice to reStructured Text (reST). It addresses the challenges and strategies for migrating content, emphasizing the need to split files, generate IDs, and finalize the structure, including the use of admonitions.

ReST Migration

reStructured Text

Repositories

Structure
As today, one per manual, but separate for languages
Git
Migration from SVN

We probably don't need to migrate any of the SVN repos from the existing official documentation. Just leave them dormant and switch to Git in the Forge projects.

Pipeline Management

Executing a job
DB entries?
Pushing to documentation.typo3.org
Registering a job
Trigger

Migration

Finalize structure
Admonitions

We haven't yet chosen the types of admonitions that we keep. Or we forgot to write it down :-/

OpenOffice to reST
Manual work
Generate id's
Split files

Serving the docs

Index pages
Automated?

JavaScript app?

FLOW3?

Manual?
Straight from rendered HTML
Augmentation via JS

Snippets

Comments

Surf the file structure
Search

Solr?

Language
Versions

Rendering

srv123.typo3.org
Final name

sphinx.typo3.org?

rendering.typo3.org?

Sphinx
Cross-linking
Learning
Other formats
Later
HTML
Template

Framework

Foundation

Bootstrap

Design

From new typo3.org

New manuals

I don't think that we should write any new manual in OpenOffice. This is a waste of time. But we need a temporary solution for making them available once rendered to HTML.

Temporary solution
documentation.typo3.org

Alpha version

Quickly