[TYPO3-doc] @all teams: Important! Please help: How to map Git paths to urls?

[Martin Bless]

@all: Important!
@Flow team
@Neos team
@... all

François asked me to investigate what needs to be done to render
TYPO3Flow documentation on docs.typo3.org. And he's right.

*This leads to the question:*
   How shall we map Git paths to urls?

Let's start with this package: FLOW3/Packages/TYPO3.FLOW3.git
In there we have several "Documentation/" folders which some of
them not containing the Documentation itself.

FLOW3/Documentation.git/Documentation
FLOW3/Packages/TYPO3.DocTools/Documentation
FLOW3/Packages/TYPO3.FLOW3.git/Classes/TYPO3/Flow/Package/Documentation
FLOW3/Packages/TYPO3.FLOW3.git/Documentation
FLOW3/Packages/TYPO3.FLOW3.git/Tests/Unit/Package/Documentation
FLOW3/Packages/TYPO3.Fluid.git/Documentation


Let me start a CSV table here to begin with such a mapping.
Consider a pair to be in the same line.

Please note that urls made up in way with the reader in mind. The
urls are meant to be humanfriendly and reflect the actual spoken
name and written title of a manual. It is in this mapping where we
make the transition from technical paths to humanfriendly names.

Draft of a CSV table:
=====================

GitRepositoryName,
WebUrl

Documentation/TYPO3/Example/ExtensionManual.git,
docs.typo3.org/typo3cms/ExtensionManualExample/

Documentation/TYPO3/Example/OfficialManual.git,
docs.typo3.org/typo3cms/OfficialManualExample/

Documentation/TYPO3/Guide/Administrators.git,
docs.typo3.org/typo3cms/AdministratorsGuide/

Documentation/TYPO3/Guide/FrontendLocalization.git,
docs.typo3.org/typo3cms/FrontendLocalizationGuide/

Documentation/TYPO3/Guide/Installation.git,
docs.typo3.org/typo3cms/InstallationGuide/

Documentation/TYPO3/Guide/Security.git,
docs.typo3.org/typo3cms/SecurityGuide/

Documentation/TYPO3/Reference/CodingGuidelines.git,
docs.typo3.org/typo3cms/CodingGuidelinesReference/

Documentation/TYPO3/Reference/CoreApi.git,
docs.typo3.org/typo3cms/CoreApiReference/

Documentation/TYPO3/Reference/FileAbstractionLayer.git,
docs.typo3.org/typo3cms/FileAbstractionLayerReference/

Documentation/TYPO3/Reference/IndexedSearch.git,
docs.typo3.org/typo3cms/IndexedSearchReference/

Documentation/TYPO3/Reference/InsideTypo3.git,
docs.typo3.org/typo3cms/InsideTypo3Reference/

Documentation/TYPO3/Reference/Skinning.git,
docs.typo3.org/typo3cms/SkinningReference/

Documentation/TYPO3/Reference/Tca.git,
docs.typo3.org/typo3cms/TcaReference/

Documentation/TYPO3/Reference/Tsconfig.git,
docs.typo3.org/typo3cms/TsconfigReference/

Documentation/TYPO3/Reference/Typo3Services.git,
docs.typo3.org/typo3cms/Typo3ServicesReference/

Documentation/TYPO3/Reference/Typoscript.git,
docs.typo3.org/typo3cms/TyposcriptReference/

Documentation/TYPO3/Reference/TyposcriptSyntax.git,
docs.typo3.org/typo3cms/TyposcriptSyntaxReference/

Documentation/TYPO3/Tutorial/Editors.git,
docs.typo3.org/typo3cms/EditorsTutorial/

Documentation/TYPO3/Tutorial/GettingStarted.git,
docs.typo3.org/typo3cms/GettingStartedTutorial/

Documentation/TYPO3/Tutorial/Typoscript45Minutes.git,
docs.typo3.org/typo3cms/TyposcriptIn45MinutesTutorial/

TYPO3v4/Extensions/news.git,
docs.typo3.org/typo3cms/Extensions/news/

FLOW3/Documentation.git/Documentation,
docs.typo3.org/typo3flow/

FLOW3/Packages/TYPO3.DocTools/Documentation,
docs.typo3.org/typo3flow/typo3/DocTools/

FLOW3/Packages/TYPO3.FLOW3.git/Documentation,
docs.typo3.org/typo3flow/typo3/flow/

FLOW3/Packages/TYPO3.Fluid.git/Documentation,
docs.typo3.org/typo3flow/typo3/Fluid/


I suggest to start the discussion here and to create a document
then in the web (a table) that provides a better overview and
layout than this mail.

Get up!

Martin

-- 
Certified TYPO3 Integrator | TYPO3 Documentation Team Member

http://mbless.de