Grants:Project/Jayprakash12345/Improve documentation of MediaWiki maintenance scripts/Timeline

This project is funded by a Project Grant

proposal

people

timeline & progress

finances

midpoint report

final report

Timeline for Jayprakash12345

Timeline	Date
Document first 60 scripts	10 November 2021 (Done)
Document another next and remaining 60 scripts	08 Feb 2022 (Done)
Restructured landing pages	24 Feb 2022 (Done)

Monthly updates

Please prepare a brief project update each month, in a format of your choice, to share progress and learnings with the community along the way. Submit the link below as you complete each update.

June

• Setup mw:Project Pralekhan page
• Communicate with Alex Paskulin (WMF's technical writer) as she is project advisor
• Deeply studied mw:Documentation/Technical documentation templates and suggestions
• Also, grantee was recovering from COVID-19 with his family in this month.

July

No activity, as grantee had their end semester examination.

Auguest

• Created sidebar page for Maintenance script.
• Grantee took a Unconference session on this project at Wikimania 2021 to showcase and take feedback from community.
• Grantee have been announced as Technical Innovator, Wikimedia of the Year in Wikimania 2021 so that he had to take training from WMF's Communication team so less activity.

September

• Grantee documented the below scripts with the following details.

S. No.	Script	Details	Parameter/Options	Usage	See also	Category
1	generateSchemaSql.php	Y	Y	Y	N	Y
2	makeTestEdits.php	Y	Y	Y	Y	Y
3	findMissingFiles.php	Y	Y	Y	Y	Y
4	findDeprecated.php	Y	N (n/a)	Y	Y	Y
5	invalidateUserSessions.php	Y	Y	Y	Y	Y
6	jsparse.php	Y	Y	Y	Y	Y
7	validateRegistrationFile.php	Y	Y	Y	Y	Y
8	resetPageRandom.php	Y	Y	Y	Y	Y
9	dumpCategoriesAsRdf.php	Y	Y	Y	Y	Y
10	mysql.php	Y	Y	Y	Y	Y
11	view.php	Y	Y	Y	Y	Y
12	protect.php	Y	Y	Y	Y	Y

• Grantee created following categories:
  • mw:Category:Content maintenance scripts
  • mw:Category:Database maintenance scripts
  • mw:Category:User maintenance scripts
  • mw:Category:File maintenance scripts
  • mw:Category:Development maintenance scripts
• Grantee did not document many scripts as he was waiting for feedback from Alex Paskulin (Project advisor).

October

• Grantee had the first meeting (6 Oct 2021) with APaskulin (WMF) with the following notes:
  • Planning to finish by December, but an extension is possible, very common with grants
  • Remove jay@pc text from scripts
  • Remove - from scripts
  • Discuss on Maintenance_scripts/Sidebar
  • Discuss on Potential use of DynamicPageList
  • Use <h4> in usage section
  • Use Template:Codesample
  • Use Description text to wikitable
  • Meet every 20 days
  • Zulip chat in between meetings
  • For scripts that don't need 3000 bytes of documentation, it's ok to add less documentation if that is appropriate. The most important thing is having the correct amount of information on the page.

• Grantee had the second meeting (28 Oct 2021) with APaskulin (WMF) with the following notes:
  • Demo on usage of DynamicPageList for maintenance script. See: mw:User:Jayprakash12345/Scripts
  • 25 scripts has been documented since the last meeting
  • Feedback gadget
  • This data was stored in WMF eventlogging data, stored for only 90 days
  • Linking to the talk page is ok for people who have feedback or want to ask a question, but this doesn't provide any way to leave generic positive feedback

• Grantee documented the below scripts with the following details.

S. No.	Script	Details	Parameter/Options	Usage	See also	Category
13	mctest.php	Y	Y	Y	Y	Y
14	orphans.php	Y	Y	Y	Y	Y
15	populateInterwiki.php	Y	Y	Y	Y	Y
16	purgeModuleDeps.php	Y	Y	Y	Y	Y
17	mcc.php	Y	Y	Y	Y	Y
18	addSite.php	Y	Y	Y	Y	Y
19	categoryChangesAsRdf.php	Y	Y	Y	Y	Y
20	deleteTag.php	Y	Y	Y	Y	Y
21	exportSites.php	Y	Y	Y	Y	Y
22	importSites.php	Y	Y	Y	Y	Y
23	refreshFileHeaders.php	Y	Y	Y	Y	Y
24	renameRestrictions.php	Y	Y	Y	Y	Y
25	initUserPreference.php	Y	Y	Y	Y	Y
26	cleanupRevActorPage.php	Y	Y	Y	Y	Y
27	checkBadRedirects.php	Y	Y	Y	Y	Y
28	findOrphanedFiles.php	Y	Y	Y	Y	Y
29	migrateFileRepoLayout.php	Y	Y	Y	Y	Y
30	copyFileBackend.php	Y	Y	Y	Y	Y
31	updateCredits.php	Y	Y	Y	Y	Y
32	manageForeignResources.php	Y	Y	Y	Y	Y
33	cleanupRemovedModules.php	Y	Y	Y	Y	Y
34	populateBacklinkNamespace.php	Y	Y	Y	Y	Y
35	populateRevisionSha1.php	Y	Y	Y	Y	Y
36	runBatchedQuery.php	Y	Y	N	Y	Y
37	syncFileBackend.php	Y	Y	Y	Y	Y

November

• Grantee had the third meeting (15 Nov 2021) with APaskulin (WMF) with the following notes:
  • 23 scripts has been documented since the last meeting
  • User feedback task: phab:T295695
  • Remove "only" text
  • There are only a few typos error
  • Alex to follow up with WMF legal
  • Jay to design experiment to use Google Forums for collecting feedback
  • Wrap up in January (likely)

• Grantee created following categories:
  • mw:Category:Stats maintenance scripts
  • mw:Category:Logs maintenance scripts
  • mw:Category:Interwiki maintenance scripts
• Grantee documented the below scripts with the following details.

S. No.	Script	Details	Parameter/Options	Usage	See also	Category
38	checkImages.php	Y	Y	Y	Y	Y
39	manageJobs.php	Y	Y	Y	Y	Y
40	mergeMessageFileList.php	Y	Y	Y	Y	Y
41	cleanupBlocks.php	Y	Y	Y	Y	Y
42	addRFCandPMIDInterwiki.php	Y	Y	Y	Y	Y
43	checkDependencies.php	Y	Y	Y	Y	Y
44	deduplicateArchiveRevId.php	Y	Y	Y	Y	Y
45	deleteAutoPatrolLogs.php	Y	Y	Y	Y	Y
46	populateIpChanges.php	Y	Y	Y	Y	Y
47	minify.php	Y	Y	Y	Y	Y
48	populatePPSortKey.php	Y	Y	Y	Y	Y
49	refreshExternallinksIndex.php	Y	Y	Y	Y	Y
50	checkLess.php	Y	Y	Y	Y	Y
51	deleteSelfExternals.php	Y	Y	Y	Y	Y
52	populateArchiveRevId.php	Y	Y	Y	Y	Y
53	updateArticleCount.php	Y	Y	Y	Y	Y
54	cleanupWatchlist.php	Y	Y	Y	Y	Y
55	deleteLocalPasswords.php	Y	Y	Y	Y	Y
56	populateParentId.php	Y	Y	Y	Y	Y
57	removeUnusedAccounts.php	Y	Y	Y	Y	Y
58	purgeExpiredWatchlistItems.php	Y	Y	Y	Y	Y
59	purgeExpiredUserrights.php	Y	Y	Y	Y	Y
60	updateExtensionJsonSchema.php	Y	Y	Y	Y	Y

December

• Grantee documented the below scripts with the following details.

S. No.	Script	Details	Parameter/Options	Usage	See also	Category
61	getConfiguration.php	Y	Y	Y	Y	Y
62	renameDbPrefix.php	Y	Y	Y	Y	Y
63	updateRestrictions.php	Y	Y	Y	Y	Y
64	initEditCount.php	Y	Y	Y	Y	Y
65	patchSql.php	Y	Y	Y	Y	Y
66	convertUserOptions.php	Y	Y	Y	Y	Y
67	preprocessorFuzzTest.php	Y	Y	Y	Y	Y
68	fixExtLinksProtocolRelative.php	Y	Y	Y	Y	Y
69	dumpLinks.php	Y	Y	Y	Y	Y
70	generateLocalAutoload.php	Y	Y	Y	Y	Y
71	cleanupInvalidDbKeys.php	Y	Y	Y	Y	Y
72	getReplicaServer.php	Y	Y	Y	Y	Y
73	checkUsernames.php	Y	Y	Y	Y	Y
74	rebuildmessages.php	Y	Y	Y	Y	Y
75	formatInstallDoc.php	Y	Y	Y	Y	Y
76	showSiteStats.php	Y	Y	Y	Y	Y
77	rebuildImages.php	Y	Y	Y	Y	Y
78	deleteOrphanedRevisions.php	Y	Y	Y	Y	Y
79	importSiteScripts.php	Y	Y	Y	Y	Y
80	checkComposerLockUpToDate.php	Y	Y	Y	Y	Y
81	deleteDefaultMessages.php	Y	Y	Y	Y	Y

January

• 34 scripts (from 82-115) has been documented.
• Grantee documented the below scripts with the following details.

S. No.	Script	Details	Parameter/Options	Usage	See also	Category
82	purgeChangedPages.php	Y	Y	Y	Y	Y
83	fixTimestamps.php	Y	Y	Y	Y	Y
84	migrateImageCommentTemp.php ‎	Y	Y	Y	Y	Y
85	tidyUpT39714.php	Y	Y	Y	Y	Y
86	uppercaseTitlesForUnicodeTransition.php	Y	Y	Y	Y	Y
87	fixDefaultJsonContentPages.php	Y	Y	Y	Y	Y
88	populateFilearchiveSha1.php	Y	Y	Y	Y	Y
89	populateImageSha1.php	Y	Y	Y	Y	Y
90	populateExternallinksIndex60.php	Y	Y	Y	Y	Y
91	populateLogSearch.php	Y	Y	Y	Y	Y
92	compareParserCache.php	Y	Y	Y	Y	Y
93	findHooks.php	Y	Y	Y	Y	Y
94	fileOpPerfTest.php	Y	Y	Y	Y	Y
95	getSlaveServer.php	Y	Y	Y	Y	Y
96	mwdoc-filter.php	Y	Y	Y	Y	Y
97	populateRecentChangesSource.php ‎	Y	Y	Y	Y	Y
98	populateRevisionLength.php	Y	Y	Y	Y	Y
99	populateContentTables.php	Y	Y	Y	Y	Y
100	pruneFileCache.php‎	Y	Y	Y	Y	Y
101	purgeChangedFiles.php	Y	Y	Y	Y	Y
102	populateLogUsertext.php	Y	Y	Y	Y	Y
103	clearInterwikiCache.php	Y	Y	Y	Y	Y
104	eraseArchivedFile.php	Y	Y	Y	Y	Y
105	deleteBatch.php	Y	Y	Y	Y	Y
106	refreshImageMetadata.php	Y	Y	Y	Y	Y
107	populateCategory.php	Y	Y	Y	Y	Y
108	nukePage.php	Y	Y	Y	Y	Y
109	updateDoubleWidthSearch.php	Y	Y	Y	Y	Y
110	dumpTextPass.php	Y	Y	Y	Y	Y
111	attachLatest.php‎	Y	Y	Y	Y	Y
112	fixUserRegistration.php	Y	Y	Y	Y	Y
113	updateCollation.php‎	Y	Y	Y	Y	Y
114	copyJobQueue.php‎	Y	Y	Y	Y	Y
115	wrapOldPasswords.php‎	Y	Y	Y	Y	Y

February

• Grantee documented the below scripts with the following details.

S. No.	Script	Details	Parameter/Options	Usage	See also	Category
116	alltrans.php	Y	Y	Y	Y	Y
117	langmemusage.php	Y	Y	Y	Y	Y
118	dumpMessages.php	Y	Y	Y	Y	Y
119	digit2html.php	Y	Y	Y	Y	Y
120	benchmarkHooks.php	Y	Y	Y	Y	Y
121	benchmarkParse.php	Y	Y	Y	Y	Y
122	benchmarkPurge.php	Y	Y	Y	Y	Y
123	checkStorage.php	Y	Y	Y	Y	Y
124	moveToExternal.php	Y	Y	Y	Y	Y
125	lag.php	Y	Y	Y	Y	Y
126	dumpRev.php	Y	Y	Y	Y	Y
127	date-formats.php	Y	Y	Y	Y	Y
128	listVariants.php	Y	Y	Y	Y	Y
129	sql.php	Y	Y	Y	Y	Y
130	SqliteMaintenance.php	Y	Y	Y	Y	Y
131	sqlite.php	Y	Y	Y	Y	Y
132	sqlite.inc	Y	n/a	n/a	Y	Y
133	doMaintenance.php	Y	n/a	Y	Y	Y
134	createCommonPasswordCdb.php	Y	Y	Y	Y	Y

• Publish final feedback form to get community insights on 25 Feb.

March

• Grantee documented the below scripts with the following details.

S. No.	Script	Details	Parameter/Options	Usage	See also	Category
135	convertExtensionToRegistration.php ‎	Y	Y	Y	Y	Y
136	deleteArchivedFiles.php ‎	Y	Y	Y	Y	Y
137	deleteArchivedRevisions.php ‎	Y	Y	Y	Y	Y
138	deleteEqualMessages.php ‎	Y	Y	Y	Y	Y
139	deleteOldRevisions.php ‎	Y	Y	Y	Y	Y
140	deleteUserEmail.php‎	Y	Y	Y	Y	Y
141	fixMergeHistoryCorruption.php ‎	Y	Y	Y	Y	Y
142	getText.php‎	Y	Y	Y	Y	Y
143	fetchText.php	Y	Y	Y	Y	Y
144	findClasses.php	Y	Y	Y	Y	Y
145	emptyUserGroup.php ‎	Y	Y	Y	Y	Y
146	findMissingActors.php ‎	Y	Y	Y	Y	Y
147	getLagTimes.php	Y	Y	Y	Y	Y
148	generateConfigDefaultSettings.php ‎	Y	Y	Y	Y	Y
149	generateConfigNames.php‎	Y	Y	Y	Y	Y
150	generateConfigSchemaArray.php	Y	Y	Y	Y	Y
151	generateConfigSchemaYaml.php	Y	Y	Y	Y	Y
152	cleanupUsersWithNoId.php ‎	Y	Y	Y	Y	Y
153	createAndPromote.php	Y	Y	Y	Y	Y
154	cleanupUploadStash.php	Y	Y	Y	Y	Y
155	cleanupTitles.php	Y	Y	Y	Y	Y
156	cleanupSpam.php	Y	Y	Y	Y	Y
157	cleanupPreferences.php	Y	Y	Y	Y	Y
158	cleanupEmptyCategories.php	Y	Y	Y	Y	Y
159	cleanupCaps.php	Y	Y	Y	Y	Y
160	addChangeTag.php	Y	Y	Y	Y	Y
161	blockUsers.php ‎	Y	Y	Y	Y	Y
162	changePassword.php ‎	Y	Y	Y	Y	Y
163	createBotPassword.php ‎	Y	Y	Y	Y	Y
164	dumpUploads.php ‎	Y	Y	Y	Y	Y
165	invalidateBotPasswords.php ‎	Y	Y	Y	Y	Y
166	migrateActors.php ‎	Y	Y	Y	Y	Y
167	nukeNS.php	Y	Y	Y	Y	Y
168	pageExists.php ‎	Y	Y	Y	Y	Y
169	populateChangeTagDef.php ‎ ‎	Y	Y	Y	Y	Y
170	purgeExpiredBlocks.php‎	Y	Y	Y	Y	Y
171	purgeOldText.php	Y	Y	Y	Y	Y
172	purgePage.php‎	Y	Y	Y	Y	Y
173	reassignEdits.php	Y	Y	Y	Y	Y
174	rebuildall.php	Y	Y	Y	Y	Y
175	rebuildrecentchanges.php‎	Y	Y	Y	Y	Y
176	rebuildtextindex.php ‎ ‎	Y	Y	Y	Y	Y
177	removeInvalidEmails.php ‎ ‎	Y	Y	Y	Y	Y
178	recountCategories.php‎	Y	Y	Y	Y	Y
179	purgeMessageBlobStore.php	Y	Y	Y	Y	Y
180	purgeParserCache.php‎	Y	Y	Y	Y	Y

• Community feedback survey result out at mw:Project Pralekhan/Survey Result.

Is your final report due but you need more time?

Extension request

New end date

Feb 2021

Rationale

I have been COVID-19 infected with my family during the COVID-19 second wave in India. This delayed starting of the project. Now, I am on the path to finishing the project by Jan 2022. So I need time till Feb 2022 to submit the final report. Thank you-Jayprakash >>> Talk 19:45, 30 November 2021 (UTC)

Jay, we have reviewed and approved your progress report. It is heartening to know that you have been able to meet all of your metrics despite facing hardships during the project period. Your request for extension has been approved. THasan (WMF) (talk) 19:22, 31 January 2022 (UTC)

Noting here that the new final report is due by 30 March 2022. Thanks! -- JTud (WMF), Grants Administrator (talk) 02:50, 18 March 2022 (UTC)