Project

General

Profile

Actions

Task #77840

closed

Optimize Changelogs: Add links to Forge

Added by Martin Bless over 7 years ago. Updated over 6 years ago.

Status:
Closed
Priority:
Should have
Category:
Documentation
Target version:
Start date:
2016-09-04
Due date:
% Done:

100%

Estimated time:
TYPO3 Version:
8
PHP Version:
Tags:
Complexity:
Sprint Focus:

Description

This is a follow up to task #77787.
I'll send a patch for review.

Understanding the background

In reST we can define custom textroles for link generation. See http://www.sphinx-doc.org/en/stable/ext/extlinks.html

Until now we have defined `:forge:`77787` that generates a links to forge that looks like `Forge #77787` and links to https://forge.typo3.org/issues/77787 And we have `:review:49759` that looks like `Review #49759` and links to https://review.typo3.org/#/c/49759/.

Add links to Forge

Each change is described in a file of its own and as a document title that contains the corresponding Forge number. Thus it seems natural to to add a link to forge directly beneath that headline. The envisioned patch will exactly do that.

How to create those links easily

To insert the text I used a global regexed search and replace in PyCharm. It should work in PhpStorm just the same.

Search for ```(====+)\n.*?#(\d\d\d\d\d).*\n\1\n\n```

Replace by ```$1$2$3$4$1\n\nSee :forge:`$3`\n\n```

The dialogue:

And this is, for example, how the result looks like:

Patch for review will follow.


Files

087.png (62.8 KB) 087.png Martin Bless, 2016-09-04 15:56
086.png (62.9 KB) 086.png Martin Bless, 2016-09-04 15:57
Actions #1

Updated by Martin Bless over 7 years ago

Actions #2

Updated by Martin Bless over 7 years ago

  • File deleted (087.png)
Actions #3

Updated by Gerrit Code Review over 7 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/49858

Actions #4

Updated by Gerrit Code Review over 7 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/49858

Actions #5

Updated by Gerrit Code Review over 7 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/49858

Actions #6

Updated by Anonymous over 7 years ago

  • Status changed from Under Review to Resolved
  • % Done changed from 0 to 100
Actions #7

Updated by Gerrit Code Review over 7 years ago

  • Status changed from Resolved to Under Review

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/49898

Actions #8

Updated by Anonymous over 7 years ago

  • Status changed from Under Review to Resolved
Actions #9

Updated by Riccardo De Contardi over 6 years ago

  • Status changed from Resolved to Closed
Actions

Also available in: Atom PDF