Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Official Documentation Manuals to be supported #148

Open
11 of 13 tasks
linawolf opened this issue Jun 19, 2021 · 5 comments
Open
11 of 13 tasks

Official Documentation Manuals to be supported #148

linawolf opened this issue Jun 19, 2021 · 5 comments
Assignees

Comments

@linawolf
Copy link
Member

linawolf commented Jun 19, 2021

Core Documentation: (https://docs.typo3.org/Home/References.html)

Excluded Core Documentation:

  • ChangeLog -> Part of Core
  • System Extensions -> Part of Core
  • Fluid ViewHelper Documentation -> Currently outside our standard rendering process

Tutorials & Guides as listed here:
https://docs.typo3.org/Home/GuidesAndTutorials.html#

TYPO3CMS-Tutorial-Templating -> No images

Should we support the "Contribution Tutorials?"

  • TYPO3CMS-Guide-ContributionWorkflow
  • TYPO3CMS-Guide-HowToDocument

All checked Tutorials have their own Ticket

@linawolf linawolf pinned this issue Jun 19, 2021
@alexander-nitsche
Copy link
Contributor

Should we support the "Contribution Tutorials?"

I would consider all manuals with at least one screenshot of the TYPO3 backend or installation process and focus on these only in this first round of scripted screenshots (screenshots e.g. of forge, github, etc. in a second round):

@alexander-nitsche
Copy link
Contributor

When I run the current master branches of the TYPO3 documentation manuals, I get a different total number of screenshots than specified in the respective issues:

Manual Total Automated (issue) Automated (run)
TYPO3CMS-Book-ExtbaseFluid 43 0 0
TYPO3CMS-Tutorial-SitePackage 12 0 0
TYPO3CMS-Tutorial-Typoscript45Minutes 5 0 0
TYPO3CMS-Reference-Typoscript 43 0 0
TYPO3CMS-Reference-TSconfig 41 1 1
TYPO3CMS-Reference-CoreApi 121 1 1
TYPO3CMS-Tutorial-GettingStarted 100 10 5
TYPO3CMS-Reference-TCA 125 117 114
TYPO3CMS-Tutorial-Editors 84 18 18
TYPO3CMS-Guide-Installation 37 31 28
TYPO3CMS-Guide-ContributionWorkflow 1 0 0
TYPO3CMS-Guide-HowToDocument 3 0 0

@linawolf
Copy link
Member Author

Your numbers must be wrong. for example TYPO3CMS-Reference-Typoscript has more then 20 automated screenshots alone

@linawolf
Copy link
Member Author

This is my most recent (manual) count:

Manual Total Automated Non-TYPO3
TYPO3CMS-Book-ExtbaseFluid 43 0 19
TYPO3CMS-Tutorial-SitePackage 21 19 1
TYPO3CMS-Tutorial-Typoscript45Minutes 5 2 0
TYPO3CMS-Reference-Typoscript 38 18 0
TYPO3CMS-Reference-TSconfig 41 4 0
TYPO3CMS-Reference-CoreApi 137 99 15
TYPO3CMS-Tutorial-GettingStarted 68 27 0
TYPO3CMS-Reference-TCA 159 119 0
TYPO3CMS-Tutorial-Editors 105 68 0
TYPO3CMS-Guide-Installation 28 17 7
TYPO3CMS-Guide-ContributionWorkflow 88 0 86
TYPO3CMS-Guide-HowToDocument 57 0 ?
TYPO3CMS-Guide-FrontendLocalization 30 0 0
impexp 14 12 0
fluid_styled_content 41 38 1

@alexander-nitsche
Copy link
Contributor

Your numbers must be wrong. for example TYPO3CMS-Reference-Typoscript has more then 20 automated screenshots alone

They were collected on June 21, and on June 27 you created automatic screenshots with the codeception approach for the first time.

To get an overview of the automatic screenshots statistics you can let it do by

/t3docs-tools (main)$ ./bashScripts/get-repos.sh
/t3docs-tools (main)$ ./bashScripts/collect-stats.sh
------------------------------------------------------------------------
Automatic screenshots
------------------------------------------------------------------------
[typo3-documentation/TYPO3CMS-Book-ExtbaseFluid/11.5:./Documentation] = 0 (automatic) / 47 (all) = 0%
[typo3-documentation/TYPO3CMS-Book-ExtbaseFluid/main:./Documentation] = 0 (automatic) / 47 (all) = 0%
[typo3-documentation/TYPO3CMS-CheatSheets/main:./Documentation] = 0 (automatic) / 2 (all) = 0%
[typo3-documentation/TYPO3CMS-Example-ExtensionManual/main:./Documentation] = 0 (automatic) / 3 (all) = 0%
[typo3-documentation/TYPO3CMS-Exceptions/main:./Documentation] = 0 (automatic) / 10 (all) = 0%
[typo3-documentation/TYPO3CMS-Guide-ContributionWorkflow/main:./Documentation] = 0 (automatic) / 88 (all) = 0%
[typo3-documentation/TYPO3CMS-Guide-FrontendLocalization/11.5:./Documentation] = 0 (automatic) / 29 (all) = 0%
[typo3-documentation/TYPO3CMS-Guide-FrontendLocalization/main:./Documentation] = 0 (automatic) / 30 (all) = 0%
[typo3-documentation/TYPO3CMS-Guide-HowToDocument/main:./Documentation] = 0 (automatic) / 63 (all) = 0%
[typo3-documentation/TYPO3CMS-Guide-Installation/11.5:./Documentation] = 17 (automatic) / 28 (all) = 60.71%
[typo3-documentation/TYPO3CMS-Guide-Installation/main:./Documentation] = 17 (automatic) / 28 (all) = 60.71%
[typo3-documentation/TYPO3CMS-Reference-CoreApi/11.5:./Documentation] = 97 (automatic) / 140 (all) = 69.28%
[typo3-documentation/TYPO3CMS-Reference-CoreApi/main:./Documentation] = 97 (automatic) / 137 (all) = 70.80%
[typo3-documentation/TYPO3CMS-Reference-Skinning/main:./Documentation] = 0 (automatic) / 4 (all) = 0%
[typo3-documentation/TYPO3CMS-Reference-TCA/11.5:./Documentation] = 119 (automatic) / 159 (all) = 74.84%
[typo3-documentation/TYPO3CMS-Reference-TCA/main:./Documentation] = 119 (automatic) / 159 (all) = 74.84%
[typo3-documentation/TYPO3CMS-Reference-TSconfig/11.5:./Documentation] = 4 (automatic) / 41 (all) = 9.75%
[typo3-documentation/TYPO3CMS-Reference-TSconfig/main:./Documentation] = 4 (automatic) / 41 (all) = 9.75%
[typo3-documentation/TYPO3CMS-Reference-Typoscript/11.5:./Documentation] = 13 (automatic) / 40 (all) = 32.50%
[typo3-documentation/TYPO3CMS-Reference-Typoscript/main:./Documentation] = 13 (automatic) / 40 (all) = 32.50%
[typo3-documentation/TYPO3CMS-Tutorial-Editors/11.5:./Documentation] = 68 (automatic) / 105 (all) = 64.76%
[typo3-documentation/TYPO3CMS-Tutorial-Editors/main:./Documentation] = 68 (automatic) / 105 (all) = 64.76%
[typo3-documentation/TYPO3CMS-Tutorial-GettingStarted/11.5:./Documentation] = 27 (automatic) / 68 (all) = 39.70%
[typo3-documentation/TYPO3CMS-Tutorial-GettingStarted/main:./Documentation] = 27 (automatic) / 68 (all) = 39.70%
[typo3-documentation/TYPO3CMS-Tutorial-SitePackage/11.5:./Documentation] = 19 (automatic) / 21 (all) = 90.47%
[typo3-documentation/TYPO3CMS-Tutorial-SitePackage/main:./Documentation] = 19 (automatic) / 21 (all) = 90.47%
[typo3-documentation/TYPO3CMS-Tutorial-Typoscript45Minutes/11.5:./Documentation] = 2 (automatic) / 5 (all) = 40.00%
[typo3-documentation/TYPO3CMS-Tutorial-Typoscript45Minutes/main:./Documentation] = 2 (automatic) / 5 (all) = 40.00%
------------------------------------------------------------------------
Total = 732 (automatic) / 1534 (all) = 47.71%
------------------------------------------------------------------------

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants