Jump to content

Project Pralekhan

From mediawiki.org

Project Pralekhan (Sanskrit: प्रलेखन) is a documentation project under which MediaWiki's maintenance scripts is being improved. This project is the part of WMF's project grant which approved in May 2021.

Team

[edit]

Project goals

[edit]
  • Creating a format/structure with minimum sections like Details, Usage, Parameter/Options, and Troubleshooting.
  • Creating templates for maintenance script documentations
  • Expanding scripts having an only predefined template
  • Expanding scripts having predefined template + one-line description
  • Expanding scripts having predefined template + one-line description + outdated template
  • Expanding/Improving other scripts

Improved scripts

[edit]
S. No. Script Details Parameter/Options Usage See also Size (bytes) Category
1 generateSchemaSql.php Yes Yes Yes Yes 4,138 Yes
2 makeTestEdits.php Yes Yes Yes Yes 2,713 Yes
3 findMissingFiles.php Yes Yes Yes Yes 2,154 Yes
4 findDeprecated.php Yes Yes Yes Yes 5,418 Yes
5 invalidateUserSessions.php Yes Yes Yes Yes 2,566 Yes
6 jsparse.php Yes Yes Yes Yes 2,098 Yes
7 validateRegistrationFile.php Yes Yes Yes Yes 3,536 Yes
8 resetPageRandom.php Yes Yes Yes Yes 2,663 Yes
9 dumpCategoriesAsRdf.php Yes Yes Yes Yes 5,838 Yes
10 mysql.php Yes Yes Yes Yes 3,636 Yes
11 view.php Yes Yes Yes Yes 3,008 Yes
12 protect.php Yes Yes Yes Yes 2,566 Yes
13 mctest.php Yes Yes Yes Yes 3,641 Yes
14 orphans.php Yes Yes Yes Yes 1,662 Yes
15 populateInterwiki.php Yes Yes Yes Yes 1,900 Yes
16 purgeModuleDeps.php Yes Yes Yes Yes 883 Yes
17 mcc.php Yes Yes Yes Yes 1,867 Yes
18 addSite.php Yes Yes Yes Yes 2,593 Yes
19 categoryChangesAsRdf.php Yes Yes Yes Yes 4,719 Yes
20 deleteTag.php Yes Yes Yes Yes 1,659 Yes
21 exportSites.php Yes Yes Yes Yes 2,339 Yes
22 importSites.php Yes Yes Yes Yes 2,332 Yes
23 refreshFileHeaders.php Yes Yes Yes Yes 3,337 Yes
24 renameRestrictions.php Yes Yes Yes Yes 1,641 Yes
25 initUserPreference.php Yes Yes Yes Yes 1,440 Yes
26 cleanupRevActorPage.php Yes Yes Yes Yes 1,493 Yes
27 checkBadRedirects.php Yes Yes Yes Yes 1,383 Yes
28 findOrphanedFiles.php Yes Yes Yes Yes 3,083 Yes
29 migrateFileRepoLayout.php Yes Yes Yes Yes 2,352 Yes
30 copyFileBackend.php Yes Yes Yes Yes 3,630 Yes
31 updateCredits.php Yes Yes Yes Yes 1,171 Yes
32 manageForeignResources.php Yes Yes Yes Yes 4,107 Yes
33 cleanupRemovedModules.php Yes Yes Yes Yes 1,031 Yes
34 populateBacklinkNamespace.php Yes Yes Yes Yes 1,651 Yes
35 populateRevisionSha1.php Yes Yes Yes Yes 1,709 Yes
36 runBatchedQuery.php Yes Yes N Yes 1,680 Yes
37 syncFileBackend.php Yes Yes Yes Yes 2,136 Yes
38 checkImages.php Yes Yes Yes Yes 2,100 Yes
39 manageJobs.php Yes Yes Yes Yes 2,914 Yes
40 mergeMessageFileList.php Yes Yes Yes Yes 7,515 Yes
41 cleanupBlocks.php Yes Yes Yes Yes 920 Yes
42 addRFCandPMIDInterwiki.php Yes Yes Yes Yes 1,271 Yes
43 checkDependencies.php Yes Yes Yes Yes 2,346 Yes
44 deduplicateArchiveRevId.php Yes Yes Yes Yes 1,269 Yes
45 deleteAutoPatrolLogs.php Yes Yes Yes Yes 1,795 Yes
46 populateIpChanges.php Yes Yes Yes Yes 2,268 Yes
47 minify.php Yes Yes Yes Yes 3,218 Yes
48 populatePPSortKey.php Yes Yes Yes Yes 1,525 Yes
49 refreshExternallinksIndex.php Yes Yes Yes Yes 1,516 Yes
50 checkLess.php Yes Yes Yes Yes 1,304 Yes
51 deleteSelfExternals.php Yes Yes Yes Yes 1,198 Yes
52 populateArchiveRevId.php Yes Yes Yes Yes 1,632 Yes
53 updateArticleCount.php Yes Yes Yes Yes 2,076 Yes
54 cleanupWatchlist.php Yes Yes Yes Yes 1,852 Yes
55 deleteLocalPasswords.php Yes Yes Yes Yes 1,746 Yes
56 populateParentId.php Yes Yes Yes Yes 3,014 Yes
57 removeUnusedAccounts.php Yes Yes Yes Yes 3,055 Yes
58 purgeExpiredWatchlistItems.php Yes Yes Yes Yes 2,144 Yes
59 purgeExpiredUserrights.php Yes Yes Yes Yes 1,212 Yes
60 updateExtensionJsonSchema.php Yes Yes Yes Yes 3,543 Yes
61 getConfiguration.php Yes Yes Yes Yes 4,294 Yes
62 renameDbPrefix.php Yes Yes Yes Yes 4,815 Yes
63 updateRestrictions.php Yes Yes Yes Yes 1,176 Yes
64 initEditCount.php Yes Yes Yes Yes 2,113 Yes
65 patchSql.php Yes Yes Yes Yes 1,476 Yes
66 convertUserOptions.php Yes Yes Yes Yes 1,327 Yes
67 preprocessorFuzzTest.php Yes Yes Yes Yes 1,278 Yes
68 fixExtLinksProtocolRelative.php Yes Yes Yes Yes 1,251 Yes
69 dumpLinks.php Yes Yes Yes Yes 2,125 Yes
70 generateLocalAutoload.php Yes Yes Yes Yes 1,867 Yes
71 cleanupInvalidDbKeys.php Yes Yes Yes Yes 2,988 Yes
72 getReplicaServer.php Yes Yes Yes Yes 1,482 Yes
73 checkUsernames.php Yes Yes Yes Yes 1,698 Yes
74 rebuildmessages.php Yes Yes Yes Yes 1,500 Yes
75 formatInstallDoc.php Yes Yes Yes Yes 1,401 Yes
76 showSiteStats.php Yes Yes Yes Yes 1,251 Yes
77 rebuildImages.php Yes Yes Yes Yes 1,748 Yes
78 deleteOrphanedRevisions.php Yes Yes Yes Yes 2,161 Yes
79 importSiteScripts.php Yes Yes Yes Yes 2,834 Yes
80 checkComposerLockUpToDate.php Yes Yes Yes Yes 3,464 Yes
81 deleteDefaultMessages.php Yes Yes Yes Yes 2,226 Yes
82 purgeChangedPages.php Yes Yes Yes Yes 2,277 Yes
83 fixTimestamps.php Yes Yes Yes Yes 1,540 Yes
84 migrateImageCommentTemp.php ‎ Yes Yes Yes Yes 3,069 Yes
85 tidyUpT39714.php Yes Yes Yes Yes 1,344 Yes
86 uppercaseTitlesForUnicodeTransition.php Yes Yes Yes Yes 3,460 Yes
87 fixDefaultJsonContentPages.php Yes Yes Yes Yes 2,336 Yes
88 populateFilearchiveSha1.php Yes Yes Yes Yes 1,937 Yes
89 populateImageSha1.php Yes Yes Yes Yes 2,158 Yes
90 populateExternallinksIndex60.php Yes Yes Yes Yes 1,932 Yes
91 populateLogSearch.php Yes Yes Yes Yes 1,400 Yes
92 compareParserCache.php Yes Yes Yes Yes 2,527 Yes
93 findHooks.php Yes Yes Yes Yes 6,835 Yes
94 fileOpPerfTest.php Yes Yes Yes Yes 2,110 Yes
95 getSlaveServer.php Yes Yes Yes Yes 1,795 Yes
96 mwdoc-filter.php Yes Yes Yes Yes 2,204 Yes
97 populateRecentChangesSource.php ‎ Yes Yes Yes Yes 1,804 Yes
98 populateRevisionLength.php Yes Yes Yes Yes 1,781 Yes
99 populateContentTables.php Yes Yes Yes Yes 3,100 Yes
100 pruneFileCache.php‎ Yes Yes Yes Yes 1,507 Yes
101 purgeChangedFiles.php Yes Yes Yes Yes 2,269 Yes
102 populateLogUsertext.php Yes Yes Yes Yes 1,624 Yes
103 clearInterwikiCache.php Yes Yes Yes Yes 1,988 Yes
104 eraseArchivedFile.php Yes Yes Yes Yes 3,560 Yes
105 deleteBatch.php Yes Yes Yes Yes 4,408 Yes
106 refreshImageMetadata.php Yes Yes Yes Yes 3,874 Yes
107 populateCategory.php Yes Yes Yes Yes 2,585 Yes
108 nukePage.php Yes Yes Yes Yes 2,798 Yes
109 updateDoubleWidthSearch.php Yes Yes Yes Yes 1,529 Yes
110 dumpTextPass.php Yes Yes Yes Yes 8,161 Yes
111 attachLatest.php‎ Yes Yes Yes Yes 2,882 Yes
112 fixUserRegistration.php Yes Yes Yes Yes 1,635 Yes
113 updateCollation.php‎ Yes Yes Yes Yes 4,759 Yes
114 copyJobQueue.php‎ Yes Yes Yes Yes 4,650 Yes
115 wrapOldPasswords.php‎ Yes Yes Yes Yes 2,615 Yes
116 alltrans.php Yes Yes Yes Yes 1,439 Yes
117 langmemusage.php Yes Yes Yes Yes 1,598 Yes
118 dumpMessages.php Yes Yes Yes Yes 4,200 Yes
119 digit2html.php Yes Yes Yes Yes 6,648 Yes
120 benchmarkHooks.php Yes Yes Yes Yes 2,000 Yes
121 benchmarkParse.php Yes Yes Yes Yes 2,742 Yes
122 benchmarkPurge.php Yes Yes Yes Yes 1,830 Yes
123 checkStorage.php Yes Yes Yes Yes 1,433 Yes
124 moveToExternal.php Yes Yes Yes Yes 2,091 Yes
125 lag.php Yes Yes Yes Yes 1,287 Yes
126 dumpRev.php Yes Yes Yes Yes 1,540 Yes
127 date-formats.php Yes Yes Yes Yes 3,397 Yes
128 listVariants.php Yes Yes Yes Yes 2,405 Yes
129 sql.php Yes Yes Yes Yes 4,020 Yes
130 SqliteMaintenance.php Yes Yes Yes Yes 2,699 Yes
131 sqlite.php Yes Yes Yes Yes 2,674 Yes
132 sqlite.inc Yes n/a n/a Yes 706 Yes
133 doMaintenance.php Yes n/a Yes Yes 1,191 Yes
134 createCommonPasswordCdb.php Yes Yes Yes Yes 1,974 Yes
135 convertExtensionToRegistration.php ‎ Yes Yes Yes Yes 3,167 Yes
136 deleteArchivedFiles.php ‎ Yes Yes Yes Yes 2,002 Yes
137 deleteArchivedRevisions.php ‎ Yes Yes Yes Yes 3,703 Yes
138 deleteEqualMessages.php ‎ Yes Yes Yes Yes 2,839 Yes
139 deleteOldRevisions.php ‎ Yes Yes Yes Yes 4,161 Yes
140 deleteUserEmail.php‎ Yes Yes Yes Yes 1,745 Yes
141 fixMergeHistoryCorruption.php ‎ Yes Yes Yes Yes 2,704 Yes
142 getText.php‎ Yes Yes Yes Yes 3,739 Yes
143 fetchText.php Yes Yes Yes Yes 2,906 Yes
144 findClasses.php Yes Yes Yes Yes 1,585 Yes
145 emptyUserGroup.php ‎ Yes Yes Yes Yes 1,834 Yes
146 findMissingActors.php ‎ Yes Yes Yes Yes 2,621 Yes
147 getLagTimes.php Yes Yes Yes Yes 1,949 Yes
148 generateConfigDefaultSettings.php ‎ Yes Yes Yes Yes 1,969 Yes
149 generateConfigNames.php‎ Yes Yes Yes Yes 1,720 Yes
150 generateConfigSchemaArray.php Yes Yes Yes Yes 1,758 Yes
151 generateConfigSchemaYaml.php Yes Yes Yes Yes 1,810 Yes
152 cleanupUsersWithNoId.php ‎ Yes Yes Yes Yes 2,513 Yes
153 createAndPromote.php Yes Yes Yes Yes 4,285 Yes
154 cleanupUploadStash.php Yes Yes Yes Yes 1,767 Yes
155 cleanupTitles.php Yes Yes Yes Yes 3,771 Yes
156 cleanupSpam.php Yes Yes Yes Yes 3,039 Yes
157 cleanupPreferences.php Yes Yes Yes Yes 2,133 Yes
158 cleanupEmptyCategories.php Yes Yes Yes Yes 3,101 Yes
159 cleanupCaps.php Yes Yes Yes Yes 2,736 Yes
160 addChangeTag.php Yes Yes Yes Yes 1,442 Yes
161 blockUsers.php ‎ Yes Yes Yes Yes 3,785 Yes
162 changePassword.php ‎ Yes Yes Yes Yes 3,055 Yes
163 createBotPassword.php ‎ Yes Yes Yes Yes 3,872 Yes
164 dumpUploads.php ‎ Yes Yes Yes Yes 3,480 Yes
165 invalidateBotPasswords.php ‎ Yes Yes Yes Yes 1,703 Yes
166 migrateActors.php ‎ Yes Yes Yes Yes 3,187 Yes
167 nukeNS.php Yes Yes Yes Yes 3,095 Yes
168 pageExists.php ‎ Yes Yes Yes Yes 2,055 Yes
169 populateChangeTagDef.php ‎ ‎ Yes Yes Yes Yes 1,742 Yes
170 purgeExpiredBlocks.php‎ Yes Yes Yes Yes 1,300 Yes
171 purgeOldText.php Yes Yes Yes Yes 3,641 Yes
172 purgePage.php‎ Yes Yes Yes Yes 3,302 Yes
173 reassignEdits.php Yes Yes Yes Yes 2,250 Yes
174 rebuildall.php Yes Yes Yes Yes 3,602 Yes
175 rebuildrecentchanges.php‎ Yes Yes Yes Yes 2,316 Yes
176 rebuildtextindex.php ‎ ‎ Yes Yes Yes Yes 2,562 Yes
177 removeInvalidEmails.php ‎ ‎ Yes Yes Yes Yes 2,655 Yes
178 recountCategories.php‎ Yes Yes Yes Yes 3,607 Yes
179 purgeMessageBlobStore.php Yes Yes Yes Yes 1,470 Yes
180 purgeParserCache.php‎ Yes Yes Yes Yes 3,280 Yes

Survey

[edit]

Bug discovered

[edit]

Created Categories

[edit]