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

[François Suter]

Hi,

> - I'd like to have real database table that stores the mapping we
> (will) have agreed on. Until now these mappings are hidden
> somewhere in some shell script or Makefile files, which is bad.

You're right. I guess it would be in the TYPO3.Docs Flow package, which 
would pass the path as parameter to the rendering script, so that it 
knows where to store the stuff. I would favor putting into this package, 
because that's where we're already going to have DB tables (e.g. all the 
rendered versions of manuals) and we could have an admin interface for 
managing the paths.

> - I'd like to have a comprehensive picture of ALL stuff we want to
> present in the docs (neos, surf, flow, ...)

Sure

>     It wouldn't hurt at all, if we already knew what the subpath
>     for documentation on typo3.org will be as it has something
>     to do with the "asthetics of urls" as well.
>
>     Will it be http://typo3.org/docs/ ???

I guess it depends what form of integration is achieved eventually. All 
I can say is that the current path is:

http://typo3.org/documentation/document-library/

> Considering (1) to (5) I'd really like to see "typo3cms" there. So
> we might come up with:
> http://typo3.org/docs/typo3cms/CoreApiReference/

OK, I agree with (some of) your points. I can live with "typo3cms" as 
long as it's an exception.

> - I'm not sure if it has to be /docs/typo3flow/... as flow, surf,
> neos and so on don't collide that much with the TYPO3 as family
> brand name.

I really think not having "typo3xxxx" (but just "xxxx") in these cases 
is better.

>> It would be good to have the Flow team's point of view on this issue.
>
> Indeed, as I must say that I don't have the knowledge for this
> kind of thing.

I don't think anyone really has, but we'll have to work out something. 
Collecting ideas and preferences is a start ;-)

> - And now, once again after the rebranding and with the upcoming
> 6.0 release in mind, let's think about upper and lower case once
> again. Will we only have lower case until we reach the crucial
> part, that is the actual manual?

I would say yes. The sure thing is that the parts of the path that are 
managed by typo3.org will definitely be lowercase, since they will be 
generated by TYPO3/RealURL. After that I would expect the mixed case 
from docs.typo3.org to be used anyway no matter how the integration is 
achieved, although I could imagine typo3.org parsing the content fetched 
from docs.typo3.org and lowercasing the links. I'm not sure it would be 
very useful.

> (A)
> http://typo3.org/docs/typo3cms/extensions/news
> http://typo3.org/docs/typo3cms/CoreApiReference/
> http://typo3.org/docs/flow/package/flow/
>
>
> In summary:
> * I strongly vote for having "typo3cms" instead of only "cms".

Fine with me.

> * I like (A).

Looks quite good. We just don't know what the start of the path could be 
like yet.

> * I'd like all of us to agree on a concrete mapping table.

Indeed, we need that!

Cheers

-- 

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