Bug #83480: Documentation: Wrong 'version' in Settings.cfg - TYPO3 Core - TYPO3 Forge

Actions

Copy link

Bug #83480

closed

Documentation: Wrong 'version' in Settings.cfg

Added by Martin Bless almost 7 years ago. Updated about 6 years ago.

Status:

Closed

Priority:

Must have

Assignee:

Category:

Documentation

Target version:

Start date:

2018-01-05

Due date:

% Done:

100%

Estimated time:

TYPO3 Version:

PHP Version:

Tags:

Complexity:

Is Regression:

Sprint Focus:

Description

Background¶

The 'version' and 'release' settings that get displayed are in the hands of the documentation authors. They are specified in the ./Documentation/Settings.cfg file. We don't differentiate between the two. So it's the 'release' that gets displayed.

Bug¶

At the moment quite of few of these settings are wrong. This one has been reported right now:

What needs to be done¶

Please use "6.2", "7.6", "8.7" and "latest", as these are in sync with the urls and filepaths. Even better: For "latest" write "latest (9-dev)" (or whatever dev-version we've reached) as this is better understandable. Simply set both, version and release to the same value.

Attached files¶

1. a logfile that illustrates the problem
2. a bash script to recreate the logfile

Recommendation¶

The script should probably be added to the list of steps that need to be done when a new TYPO3 release of published.

Let's rock on.

Files

Download all files

docs.png (53.4 KB) docs.png		Martin Bless, 2018-01-05 12:17
versions-log.txt (8.93 KB) versions-log.txt		Martin Bless, 2018-01-05 12:17
check_versions_of_settings_files.sh (1.07 KB) check_versions_of_settings_files.sh		Martin Bless, 2018-01-05 12:17

Actions

Copy link

Updated by Sybille Peters over 6 years ago

So, to summarize what needs to be done:

branch TYPO3_6-2: all clear, "6.2" is used for all
branch TYPO3_7-6: several should be changed to "7.6"
branch TYPO3_8-7: several should be changed to "8.7"
branch master: several should be changed to latest (9-dev)

(the other branches like TYPO3_8-6 or TYPO3_7-3 can be skipped, I think)

I will create patches for this ... stand by.

About running the script when a release is created, I think you (Martin) would need to ping someone who can take care of that.

Actions

Copy link

Updated by Gerrit Code Review over 6 years ago

Status changed from New to Under Review

Patch set 1 for branch master of project Packages/TYPO3.CMS has been pushed to the review server.
It is available at https://review.typo3.org/56476

Actions

Copy link

Updated by Gerrit Code Review over 6 years ago

Patch set 1 for branch TYPO3_8-7 of project Packages/TYPO3.CMS has been pushed to the review server.
It is available at https://review.typo3.org/56478

Actions

Copy link

Updated by Gerrit Code Review over 6 years ago

Patch set 2 for branch TYPO3_8-7 of project Packages/TYPO3.CMS has been pushed to the review server.
It is available at https://review.typo3.org/56478

Actions

Copy link

Updated by Gerrit Code Review over 6 years ago

Patch set 2 for branch master of project Packages/TYPO3.CMS has been pushed to the review server.
It is available at https://review.typo3.org/56476

Actions

Copy link

Updated by Gerrit Code Review over 6 years ago

Patch set 1 for branch TYPO3_7-6 of project Packages/TYPO3.CMS has been pushed to the review server.
It is available at https://review.typo3.org/56479

Actions

Copy link

Updated by Tymoteusz Motylewski over 6 years ago

What about v9 branch? this apporach would require to rename v9 url documentation from 9-dev to 9.7 or 9.8 ?
this would mean a lot of broken links in google.

Actions

Copy link

Updated by Gerrit Code Review over 6 years ago

Patch set 3 for branch master of project Packages/TYPO3.CMS has been pushed to the review server.
It is available at https://review.typo3.org/56476

Actions

Copy link

Updated by Gerrit Code Review over 6 years ago

Patch set 3 for branch TYPO3_8-7 of project Packages/TYPO3.CMS has been pushed to the review server.
It is available at https://review.typo3.org/56478

Actions

Copy link

#10

Updated by Gerrit Code Review over 6 years ago

Patch set 2 for branch TYPO3_7-6 of project Packages/TYPO3.CMS has been pushed to the review server.
It is available at https://review.typo3.org/56479

Actions

Copy link

#11

Updated by Gerrit Code Review over 6 years ago

Patch set 1 for branch TYPO3_8-7 of project Packages/TYPO3.CMS has been pushed to the review server.
It is available at https://review.typo3.org/56480

Actions

Copy link

#12

Updated by Gerrit Code Review over 6 years ago

Patch set 1 for branch TYPO3_7-6 of project Packages/TYPO3.CMS has been pushed to the review server.
It is available at https://review.typo3.org/56481

Actions

Copy link

#13

Updated by Sybille Peters over 6 years ago

@ Tymoteusz Good point. I didn't think about that. Maybe something we should bring up in the documentation channel.

Probably this task should really be done, when a release is created. Usually for master, I may not know what the next release will be. It could be 9.1.1 or it could be 9.2.0.

I "-1" the master review for now so we can decided what to do about this.

Actions

Copy link

#14

Updated by Christian Kuhn over 6 years ago

Sybille / Tymek: Please don't create too much fuzz there at the moment. We have a concept for new links / stable links for a new docs.typo3.org server and will work on that anyway, later. I would get this in for now and look at such details with the new machine only and then maybe create redirects for the most important manuals.

Actions

Copy link

#15