TYPO3-Documentation / T3DocTeam

This repository is for the Documentation Team. To contribute, please see CONTRIBUTING.md For help and support on TYPO3, please see: https://typo3.org/help/
3 stars 1 forks source link

Provide version URLs for master #101

Closed sypets closed 4 years ago

sypets commented 5 years ago

Update: Is related to #133. As of now, I would simplify the procedure: 1 redirect /10/ to the latest version and to 10.4 once that comes out. I moved some of the text in this issue to a google doc.


Goal: Have a specific version URL for "master"

So, additionally to

/manual/master/en-us/....

we have:

/manual/10/en-us/...


Problem

Currently, there are several links to the documentation which point to URLs for master, for example in the "What's new Slides" or on "SkillsDisplay". Several of these refer to 9.5 documentation (or below). But the current master URLs on docs.typo3.org point to the 10-dev branch, so people expect to be directed to a 9 version, but they will effectively get 10.

These links (in What's new + SkillDisplay) can be fixed, but in the future it would be very helpful to have correct version URLs as soon as we branch the documentation and "master" becomes a new version.

That means, we would already support URLs with /<10-version>/ right now in addition to /master/.

What 10-version is exactly must be decided, probably it would be 10.4, as 10 LTS will be 10.4 as pointed out in roadmap. We might also decide to support /10/ URLs which will later just point to latest 10 version, e.g. 10.4.

Possible Solution

Have version URLs only with major version which redirect to respective versions, e.g. as of now:

/manual/10/en-us -> /manual/master/en-us/ (or rather latest, if #133 gets implemented)

Related

sypets commented 4 years ago

Update: I think the previous proposal was too complicated. I simplified it (above).

sypets commented 4 years ago

I think #133 would be a better solution. Closing.