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

Deletion candidates #255

Open
5 of 12 tasks
sypets opened this issue May 18, 2022 · 2 comments
Open
5 of 12 tasks

Deletion candidates #255

sypets opened this issue May 18, 2022 · 2 comments

Comments

@sypets
Copy link
Contributor

sypets commented May 18, 2022

These are deletion candidates (!). Deletion has not been decided (yet).

Reasons for deletions

  • some pages are not TYPO3 specific, are already available elsewhere, better maintained elsewhere and possibly outdated here, e.g. some of the platform specific documentation in the Appendix
  • some things could be considered prerequisites for contributing (e.g. IDE setup ..?)

What to keep

  • obviously, the TYPO3 core development specific setup
  • things that may cause confusion otherwise

Criteria

  • look at Matomo results - least accessed pages
  • outdated and not well maintained - might be indicator that no one is complaining and thus pages not being used?

List of possible deletion candidates

empty pages

obsolete pages / duplicate content

rarely used pages

"pain in the neck to maintain" pages

this is sometimes the case because content is duplicated in several places and must be maintained in several places (e.g. in Git cheat sheet, setup and "Aliases")

general non-TYPO3 specific information

Git GUIs

Tool installation

misc

sypets added a commit to sypets/TYPO3CMS-Guide-ContributionWorkflow that referenced this issue May 18, 2022
mbrodala pushed a commit that referenced this issue May 18, 2022
sypets added a commit to sypets/TYPO3CMS-Guide-ContributionWorkflow that referenced this issue Jun 2, 2022
The information is already available on the runTests.sh page
(including the "direct commands").

The additional page makes it necessary to maintain information in
several pages and is unnecessary.

Related: TYPO3-Documentation#253
Related: TYPO3-Documentation#249
Related: TYPO3-Documentation#255
@sypets
Copy link
Contributor Author

sypets commented Jun 3, 2022

Last updated: June 3, 2022

Least accessed pages

page views (14 or less page views) due to Matomo. Least accessed first.

page comment page views May 2022 May 2023
Appendix:CommitHooks is relevant, keep 0 6
index 1
Appendix top is top page, keep 1
review is necessary, keep 2 2
core mergers revert keep! 2 1
SSH Key Windows 3
Install Composer OSX 3
handling a patch tips 3
Git Tower 3
OSX top 4
Linux SSH key 4 15
core mergers backport keep! 4 1
ExtensionScanner keep
About 4
find a review 5 9
core mergers review keep! 5 1
core mergers merge keep! 5 2
install grunt 5
PhpStorm Gerrit plugin 5 5
cglFixMyCommit removed 5
sitemap 6
Appendix: resources for editors is deletion candidate 6 8
composer 6 3
Account :Slack keep
Gerrit basics 7 1
install npm remove! 7 6
Linux top keep, is toc page 8 8
forger 10 2
rebase 10 3
community 10 3
ticket workflow 10 3
add documentation 10 3
Setup your Ide
windows troubleshooting 11 4
Troubleshooting 5
core mergers top keep! 12 2
use styleguide is new! 12 5
Git CheatSheet ... ... 12
CGL 13 12
Slack 13 16
Aliases 14 17
debugging 14 14

top access pages

Most accessed first

May 2022

Some of the page with very many views, might be strays which are lost and not looking for info for TYPO3 contribution. (may need a note, as done for DDEV page).

page comment page views May 2022 May 2023
SSH key OSX 2183
DDEV 363
cherry pick 117
resolve merge conflicts 113 22
setup linux 97
change a patch 96
start page 91
git setup 77
commit message 76
Setup: setup TYPO3 74 17
setup gerrit 56
clone sourcetree (Windows) 53
prerequisites 51

...

page comment page views May 2022 May 2023
PhpStorm Setup 23

linawolf pushed a commit that referenced this issue Jun 3, 2022
The information is already available on the runTests.sh page
(including the "direct commands").

The additional page makes it necessary to maintain information in
several pages and is unnecessary.

Related: #253
Related: #249
Related: #255
@sypets
Copy link
Contributor Author

sypets commented Jul 16, 2023

Will add section "pain in the neck to maintain" pages.

and page "Aliases": https://docs.typo3.org/m/typo3/guide-contributionworkflow/main/en-us/Appendix/Aliases.html to list of pages to be deleted.

Also, PR coming up ... (after lunch)

I noticed, the docs rendering has changed and you need to use the new container, see https://docs.typo3.org/m/typo3/docs-how-to-document/main/en-us/RenderingDocs/Quickstart.html#render-documenation-with-docker

Any page which still contains the "old" rendering Docker container is a good candidate for deletion because if it has not been noticed yet, people are either not using the page or not contributing.

Also, the content was added by myself, so I am not stepping on anyone's toes (except my own) by removing it. The Aliases page actually has some views (see Matomo results above) and I find it helpful to just copy-paste the entire thing. Perhaps alternatively, we can change the setup page to have one code block which you can copy-paste in one scoop (but that should be handled separately).

sypets added a commit to sypets/TYPO3CMS-Guide-ContributionWorkflow that referenced this issue Jul 16, 2023
Additionally, some minor changes in "Adding documenation" to
reduce text (mostly unnecessary bloat).

The aliases page repeated some of the commands in "Setup", "Git cheat
sheet" and for documentation rendering.

Removing content where it is duplicate helps maintainence and keeps
existing content more up to date.

Related: TYPO3-Documentation#255
sypets added a commit to sypets/TYPO3CMS-Guide-ContributionWorkflow that referenced this issue Jul 16, 2023
Additionally, some minor changes in "Adding documenation" to
reduce text (mostly unnecessary bloat). Also, the rendering
documenation commands were removed so that it is documented
only in one place ("Writing documentation").

The aliases page repeated some of the commands in "Setup", "Git cheat
sheet" and for documentation rendering.

Removing content where it is duplicate helps maintainence and keeps
existing content more up to date.

Related: TYPO3-Documentation#255
linawolf pushed a commit that referenced this issue Jul 22, 2023
Additionally, some minor changes in "Adding documenation" to
reduce text (mostly unnecessary bloat). Also, the rendering
documenation commands were removed so that it is documented
only in one place ("Writing documentation").

The aliases page repeated some of the commands in "Setup", "Git cheat
sheet" and for documentation rendering.

Removing content where it is duplicate helps maintainence and keeps
existing content more up to date.

Related: #255
sypets added a commit to sypets/TYPO3CMS-Guide-ContributionWorkflow that referenced this issue Aug 13, 2023
These are empty pages where the content has already been removed
2 years ago.

Related: TYPO3-Documentation#255
linawolf pushed a commit that referenced this issue Aug 18, 2023
These are empty pages where the content has already been removed
2 years ago.

Related: #255
sypets added a commit to sypets/TYPO3CMS-Guide-ContributionWorkflow that referenced this issue Jan 15, 2025
This page was initially introduced to provide some information and
conventions for people editing this guide. However, the page is
only valualbe, if visible and commonly used.

Unless a general convention is established if and how to provide
information about editing a specific guide, the page is of little
value and should be removed.

Related: TYPO3-Documentation#255
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

1 participant