Page MenuHomePhabricator
Create Task
Maniphest T379448

Audit docs for backend services and add where needed
Closed, ResolvedPublic
Actions

Description

What/Why:
Some key functions in the services have JSDoc docs while many do not and many are old and likely need updating. We should add docs for many of the rest and make sure to keep them up to date.

How:
Go through both evaluator and orchestrator:

  1. Ensure the ones that exist are still true/updated.
  2. Add to the ones that are missing

Details

Related Changes in Gerrit:
SubjectRepoBranchLines +/-
wikifunctions: Upgrade orchestrator from version: 2025-01-22-203140 to 2025-01-28-144249operations/deployment-chartsmaster+1 -1
wikifunctions: Upgrade evaluators from 2024-11-26-193226 to 2024-12-16-202347operations/deployment-chartsmaster+2 -2
wikifunctions: Upgrade orchestrator from 2024-11-27-074306 to 2024-12-17-184905operations/deployment-chartsmaster+1 -1
Update function-schemata sub-module to HEAD (e88ac7e)mediawiki/extensions/WikiLambdamaster+1 -1
wikifunctions: Upgrade orchestrator from 2024-11-18-142635 to 2024-11-19-132736operations/deployment-chartsmaster+1 -1
Customize query in gerrit
Related Changes in GitLab:
TitleReferenceAuthorSource BranchDest Branch
audit + update docsrepos/abstract-wiki/wikifunctions/function-evaluator!274ecarggrace/T379448/add-update-js-docsmain
canonicalize: Add some more docsrepos/abstract-wiki/wikifunctions/function-schemata!178ecarggrace/T379448/add-update-js-docsmain
Update or add docsrepos/abstract-wiki/wikifunctions/function-orchestrator!255ecarggrace/T379448/add-update-js-docsmain
Customize query in GitLab

Related Objects

Event Timeline

ecarg created this task.Nov 9 2024, 3:01 AM
Jdforrester-WMF triaged this task as Medium priority.Nov 13 2024, 5:33 PM
Jdforrester-WMF moved this task from To Triage to 25Q2 (Oct–Dec) on the Abstract Wikipedia team board.
Jdforrester-WMF edited projects, added Abstract Wikipedia team (25Q2 (Oct–Dec)); removed Abstract Wikipedia team.
Jdforrester-WMF moved this task from Incoming to In Engineering on the Abstract Wikipedia team (25Q2 (Oct–Dec)) board.Nov 13 2024, 5:44 PM
CodeReviewBot added a project: Patch-For-Review.Nov 15 2024, 10:47 PM

ecarg opened https://gitlab.wikimedia.org/repos/abstract-wiki/wikifunctions/function-orchestrator/-/merge_requests/255

Draft: Update or add docs

CodeReviewBot added a comment.Nov 19 2024, 2:03 PM

jforrester merged https://gitlab.wikimedia.org/repos/abstract-wiki/wikifunctions/function-orchestrator/-/merge_requests/255

Update or add docs

Maintenance_bot removed a project: Patch-For-Review.Nov 19 2024, 2:32 PM
CodeReviewBot added a project: Patch-For-Review.Nov 20 2024, 7:57 AM

ecarg opened https://gitlab.wikimedia.org/repos/abstract-wiki/wikifunctions/function-schemata/-/merge_requests/178

Add some more docs

gerritbot added a comment.Nov 20 2024, 2:25 PM

Change #1093349 had a related patch set uploaded (by Jforrester; author: Jforrester):

[operations/deployment-charts@master] wikifunctions: Upgrade orchestrator from 2024-11-18-142635 to 2024-11-19-132736

https://gerrit.wikimedia.org/r/1093349

gerritbot added a comment.Nov 20 2024, 3:26 PM

Change #1093349 merged by jenkins-bot:

[operations/deployment-charts@master] wikifunctions: Upgrade orchestrator from 2024-11-18-142635 to 2024-11-19-132736

https://gerrit.wikimedia.org/r/1093349

ecarg added a project: Documentation.Nov 20 2024, 5:40 PM
CodeReviewBot added a comment.Nov 20 2024, 7:57 PM

ecarg opened https://gitlab.wikimedia.org/repos/abstract-wiki/wikifunctions/function-evaluator/-/merge_requests/274

Draft: audit + update docs

CodeReviewBot added a comment.Nov 27 2024, 8:10 PM

jforrester merged https://gitlab.wikimedia.org/repos/abstract-wiki/wikifunctions/function-schemata/-/merge_requests/178

canonicalize: Add some more docs

CodeReviewBot added a comment.Dec 11 2024, 4:17 PM

ecarg merged https://gitlab.wikimedia.org/repos/abstract-wiki/wikifunctions/function-evaluator/-/merge_requests/274

audit + update docs

Maintenance_bot removed a project: Patch-For-Review.Dec 11 2024, 4:31 PM
ecarg closed this task as Resolved.Dec 12 2024, 12:10 AM
gerritbot added a comment.Dec 12 2024, 2:19 PM

Change #1102862 had a related patch set uploaded (by Jforrester; author: Jforrester):

[mediawiki/extensions/WikiLambda@master] Update function-schemata sub-module to HEAD (e88ac7e)

https://gerrit.wikimedia.org/r/1102862

gerritbot added a project: Patch-For-Review.Dec 12 2024, 2:19 PM
CodeReviewBot added a comment.Dec 12 2024, 2:35 PM

jforrester opened https://gitlab.wikimedia.org/repos/abstract-wiki/wikifunctions/function-orchestrator/-/merge_requests/261

Update function-schemata sub-module to HEAD (e88ac7e)

CodeReviewBot added a comment.Dec 12 2024, 2:36 PM

jforrester opened https://gitlab.wikimedia.org/repos/abstract-wiki/wikifunctions/function-evaluator/-/merge_requests/284

Update function-schemata sub-module to HEAD (e88ac7e)

CodeReviewBot added a comment.Dec 12 2024, 2:36 PM

jforrester opened https://gitlab.wikimedia.org/repos/abstract-wiki/wikifunctions/wikilambda-cli/-/merge_requests/57

Update function-schemata sub-module to HEAD (e88ac7e)

CodeReviewBot added a comment.Dec 12 2024, 3:48 PM

dmartin merged https://gitlab.wikimedia.org/repos/abstract-wiki/wikifunctions/function-evaluator/-/merge_requests/284

Update function-schemata sub-module to HEAD (e88ac7e)

CodeReviewBot added a comment.Dec 12 2024, 3:50 PM

dmartin merged https://gitlab.wikimedia.org/repos/abstract-wiki/wikifunctions/function-orchestrator/-/merge_requests/261

Update function-schemata sub-module to HEAD (e88ac7e)

CodeReviewBot added a comment.Dec 12 2024, 3:51 PM

dmartin merged https://gitlab.wikimedia.org/repos/abstract-wiki/wikifunctions/wikilambda-cli/-/merge_requests/57

Update function-schemata sub-module to HEAD (e88ac7e)

gerritbot added a comment.Dec 12 2024, 3:54 PM

Change #1102862 merged by jenkins-bot:

[mediawiki/extensions/WikiLambda@master] Update function-schemata sub-module to HEAD (e88ac7e)

https://gerrit.wikimedia.org/r/1102862

Maintenance_bot removed a project: Patch-For-Review.Dec 12 2024, 4:30 PM
gerritbot added a comment.Dec 18 2024, 3:14 PM

Change #1105362 had a related patch set uploaded (by Jforrester; author: Jforrester):

[operations/deployment-charts@master] wikifunctions: Upgrade orchestrator from 2024-11-27-074306 to 2024-12-17-184905

https://gerrit.wikimedia.org/r/1105362

gerritbot added a project: Patch-For-Review.Dec 18 2024, 3:14 PM

Change #1105363 had a related patch set uploaded (by Jforrester; author: Jforrester):

[operations/deployment-charts@master] wikifunctions: Upgrade evaluators from 2024-11-26-193226 to 2024-12-16-202347

https://gerrit.wikimedia.org/r/1105363

gerritbot added a comment.Dec 18 2024, 3:16 PM

Change #1105362 merged by jenkins-bot:

[operations/deployment-charts@master] wikifunctions: Upgrade orchestrator from 2024-11-27-074306 to 2024-12-17-184905

https://gerrit.wikimedia.org/r/1105362

gerritbot added a comment.Dec 18 2024, 3:34 PM

Change #1105363 merged by jenkins-bot:

[operations/deployment-charts@master] wikifunctions: Upgrade evaluators from 2024-11-26-193226 to 2024-12-16-202347

https://gerrit.wikimedia.org/r/1105363

Jdforrester-WMF moved this task from In Engineering to Needs Sign-off on the Abstract Wikipedia team (25Q2 (Oct–Dec)) board.Dec 18 2024, 3:37 PM
Maintenance_bot removed a project: Patch-For-Review.Dec 18 2024, 4:31 PM
gerritbot added a comment.Jan 29 2025, 2:33 PM

Change #1115032 had a related patch set uploaded (by Cory Massaro; author: Cory Massaro):

[operations/deployment-charts@master] wikifunctions: Upgrade orchestrator from version: 2025-01-22-203140 to 2025-01-28-144249

https://gerrit.wikimedia.org/r/1115032

gerritbot added a project: Patch-For-Review.Jan 29 2025, 2:33 PM
gerritbot added a comment.Jan 29 2025, 2:36 PM

Change #1115032 abandoned by Cory Massaro:

[operations/deployment-charts@master] wikifunctions: Upgrade orchestrator from version: 2025-01-22-203140 to 2025-01-28-144249

Reason:

already done

https://gerrit.wikimedia.org/r/1115032

ecarg mentioned this in rMSFEe0a02d808360: audit + update docs.Oct 3 2025, 9:43 AM
DMartin-WMF mentioned this in rMSFEbd90209caab5: Update function-schemata sub-module to HEAD (e88ac7e).Oct 3 2025, 9:43 AM
Maintenance_bot removed a project: Patch-For-Review.Oct 3 2025, 10:34 AM
Content licensed under Creative Commons Attribution-ShareAlike (CC BY-SA) 4.0 unless otherwise noted; code licensed under GNU General Public License (GPL) 2.0 or later and other open source licenses. By using this site, you agree to the Terms of Use, Privacy Policy, and Code of Conduct. · Wikimedia Foundation · Privacy Policy · Code of Conduct · Terms of Use · Disclaimer · CC-BY-SA · GPL · Credits