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

[François Suter]

Hi Martin,

> 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

IIRC the Flow team originally thought about having the documentation in 
a separate repo, but finally decided against it. For most of the other 
repos, I don't know. I would really just go with 
FLOW3/Packages/TYPO3.FLOW3.git/Documentation for now.

> 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.

Haven't we been through this already? Our meeting notes say yes:

http://forge.typo3.org/projects/team-docteam/wiki/2012-08-23

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

This is what we already have, right? Excepting for the rebranding.

I would not use "typo3cms" as we already have "typo3" in the domain 
name. I would use "cms", because that's what the product name is, 
strictly speaking.

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

OK, so we have an issue here. What we see is that the names of the Flow 
repositories are far more consistent, since the already include a 
namespace hierarchy. IMO the above URL looks terrible, because of the 
redundancies of words. But of course since "flow" is the product and 
also the name of base package containing the documentation, we have a 
duplicate anyway. At the very least, we should drop "TYPO3" when it is 
the first "segment" of the repo's namespace. And use just "flow" for the 
product name. This means we would have URLs like:

docs.typo3.org/flow/flow/

This doesn't look great either, but I don't know how we can avoid that. 
Maybe by deciding to use "packages" since all Flow code is wrapped in 
packages. So we could have:

docs.typo3.org/flow/package/flow/

It would be good to have the Flow team's point of view on this issue.

Cheers

-- 

Francois Suter
Cobweb Development Sarl - http://www.cobweb.ch