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

[Steffen Gebert]

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

Hi Martin,

we started a discussion here:
https://notes.typo3.org/p/renaming-technical-todo

During that renaming, I'm really in favor of doing it a clean way to
enable such mappings.

Would be nice to get some more feedback, also to Roberts suggestion.

Kind regards
Steffen

- -- 
Steffen Gebert
TYPO3 CMS Core Team Member
TYPO3 Server Administration Team Member

TYPO3 .... inspiring people to share!
Get involved: http://typo3.org

I work for TYPO3 solely in my spare time. If you think that
my work helps you running your business, you are invited to
send me a donation via PayPal to this email address. Thanks

On 10/30/12 10:08 AM, Martin Bless wrote:
> @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
> 
-----BEGIN PGP SIGNATURE-----
Version: GnuPG/MacGPG2 v2.0.18 (Darwin)
Comment: GPGTools - http://gpgtools.org
Comment: Using GnuPG with Mozilla - http://enigmail.mozdev.org/

iQEcBAEBAgAGBQJQkndyAAoJEIskG/rSlyw4xr8H+gP6L+cJsDXb5x5OrY6tT0sy
ehU1qM7gZPZZGzuz1UE1XiwaXEA0FipuS5olhhd8h+0O0yiV2IgnyifFTwhQce2N
mb7ZBhzlrpU8O/BuV7uVf8qVR/CZcWr9GcFCuUIRg7BWtgj0RcPdoOfKZi6k/LAe
VIZ1u/RuurNjbmL29PfGZ1CPeZKJYyqMy753P9kpk62dZjITCP4f7tcYlChBuJlP
joppV2SHVfHuuPpKLoN0rYNnrf8es9ZFzNHMTL7XCraWLhzEVKls8tWh9DssG6qT
ukOmWMACsJEXEu1ztB+GX2PEmm+1xnqRUFFxbgY4Z0tjz19gwll8yiX1l6mJKb4=
=DmdQ
-----END PGP SIGNATURE-----