Task #85725

Add directories created by rendering of documentation to .gitignore

Added by Sybille Peters over 1 year ago. Updated about 1 year ago.

Status:
Closed
Priority:
Should have
Category:
-
Target version:
-
Start date:
2018-08-02
Due date:
% Done:

100%

TYPO3 Version:
9
PHP Version:
Tags:
Complexity:
Sprint Focus:

Associated revisions

Revision b493c31d (diff)
Added by Sybille Peters over 1 year ago

[TASK] Add documentation render directories to .gitignore

Add directory created by documentation rendering to .gitignore.

Rendering the docs locally is helpful for checking if it will render
correctly on the server. This will create the rendered files in
typo3/sysext/*/Documentation-GENERATED-temp/.

Adding this to .gitignore will prevent accidentally adding the generated
documentation to a patch.

Resolves: #85725
Releases: master, 8.7
Change-Id: Ibcff2570b961e1f1add519ead49e565c671a28ba
Reviewed-on: https://review.typo3.org/57771
Tested-by: TYPO3com <>
Reviewed-by: Jörg Bösche <>
Reviewed-by: Anja Leichsenring <>
Tested-by: Anja Leichsenring <>
Reviewed-by: Björn Jacob <>
Tested-by: Björn Jacob <>
Reviewed-by: Wouter Wolters <>
Tested-by: Wouter Wolters <>

Revision 90223e52 (diff)
Added by Sybille Peters over 1 year ago

[TASK] Add documentation render directories to .gitignore

Add directory created by documentation rendering to .gitignore.

Rendering the docs locally is helpful for checking if it will render
correctly on the server. This will create the rendered files in
typo3/sysext/*/Documentation-GENERATED-temp/.

Adding this to .gitignore will prevent accidentally adding the generated
documentation to a patch.

Resolves: #85725
Releases: master, 8.7
Change-Id: Ibcff2570b961e1f1add519ead49e565c671a28ba
Reviewed-on: https://review.typo3.org/57857
Tested-by: TYPO3com <>
Reviewed-by: Wouter Wolters <>
Tested-by: Wouter Wolters <>

History

#1 Updated by Sybille Peters over 1 year ago

Not sure which category to use, I just left category unassigned.

#2 Updated by Gerrit Code Review over 1 year 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/57771

#3 Updated by Gerrit Code Review over 1 year 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/57771

#4 Updated by Sybille Peters over 1 year ago

  • Subject changed from Add directory created by rendering of Changelog to .gitignore to Add directories created by rendering of documentation to .gitignore

Rendering documentation with the docker container leaves generated directories. These should be ignored via .gitignore.

Example:

cd typo3/sysext/core
source <(docker run --rm t3docs/render-documentation show-shell-commands)
dockrun_t3rdf makehtml

creates directory

typo3/sysext/core/Documentation-GENERATED-temp

#5 Updated by Gerrit Code Review over 1 year 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/57857

#6 Updated by Sybille Peters over 1 year ago

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

#7 Updated by Benni Mack about 1 year ago

  • Status changed from Resolved to Closed

Also available in: Atom PDF