Page MenuHomePhabricator
Create Task
Maniphest T303229

Create a design for having short descriptions on function pages
Closed, ResolvedPublic
Actions

Description

After the rollout of the about widget (also known as label box) every Wikifunctions object can feature an object description. This is the case for all objects (types, implementations, testers, …) except functions.

The following proposal suggest a solution for providing and displaying the object descriptions on functions pages too.

On create, and or edit mode we will add a new “Short descriptions” input filed right below the “Name” field. If possible we can reuse the component that we currently use on the about widget, since it comes with a character counter. The input label for the time being is the same as the one being used in the about widget.

image.png (1×2 px, 199 KB)

In view (or read) mode we can display the description in the same location as the the existing placeholder text that is available in the about tab (“ This is where the summary of the function's description will go…”).

image.png (1×2 px, 403 KB)

Every now and then we’ve been talking about possible solution to merge the “About” and “Details” tab on the function view page. While working on this task, we noticed that we have an opportunity to do just that while also reusing existing components such the the about widget, the function explorer widget, and the upcoming function evaluator widget.

If possible, we would suggest to opt for the following approach while addressing this task. We can display the existing information:

  • function name, description, aliases (in multiple languages) via the about widget
  • function input type and label, and output type via the function explorer widget
  • function evaluatore via the upcoming function evaluator widget
  • create function implementation/tester links available via a dedicated button right above the respective tables

image.png (1×1 px, 222 KB)

Link to Figma file https://www.figma.com/file/adHQ474vMQmfTm7KaO6v4w/T303229-Function-description?type=design&node-id=0%3A1&t=hkiPiyUMyXdX31tu-1

Related Objects
Search...

StatusSubtypeAssignedTask
 ResolvedNoneT311172 Design review for edit function and view function
 OpenBUG REPORTNoneT344206 Special:MathStatus exception error on Wikifunctions
 OpenNoneT342865 Post-creation work for wikifunctionswiki
 ResolvedBTullisT289316 Prepare and check storage layer for Wikifunctions.org (new public content wiki)
 ResolvedJdforrester-WMFT275945 Create Wikifunctions.org
 ResolvedJdforrester-WMFT299176 Phase Theta – Root task
 ResolvedcmassaroT299596 Add security limits to the Wikifunctions system to maintain availability and load factors
 ResolvedcmassaroT291412 Add a length restriction to labels in the UX for editing them
 ResolvedJdforrester-WMFT302017 Upgrade function-orchestrator and function-evaluator services to service-runner 3.0.0 or later
 ResolvedcmassaroT282920 Implement per-request timeout / resource consumption limits in the orchestrator
 ResolvedcmassaroT338272 Create Rate Limit in Evaluator/Orchestrator
 ResolvedDVrandecicT299598 Add security limits to the Wikifunctions system to maintain stability and integrity of the content
 ResolvedgenghT260314 Restrict making content (non-label/alias) changes to system-provided ZObjects to users with a special right
 ResolvedDVrandecicT260315 Create a file containing the core types to upload to wiki
 ResolvedDVrandecicT269182 Figure out validation and well-formedness
 ResolvedgenghT299600 Restrict associating & disassociating Testers and Implementations to ZFunctions to users with a special right
 ResolvedJdforrester-WMFT299601 Restrict creating Types to users with a special right
 ResolvedgenghT299602 Restrict altering Types to users with a special right
 ResolvedgenghT299603 Restrict editing Implementations and Testers which are associated with their Function to users with a special right
 ResolvedgenghT299604 Restrict altering Function definitions to users with a special right
 ResolvedgenghT303338 The WikiLambda system understands the nature of changes being made and can react to them
 ResolvedgenghT303339 Provide a tree-diffing system for WikiLambda that allows us to compare changes to ZObjects
 ResolvedgenghT303340 Decide whether we're going to re-use an existing tree-diffing system or build our own
 ResolvedgenghT315882 WikiLambda: implement diffing algorithm
 ResolvedgenghT321183 Design an architecture proposal for user authorization that can use the data returned from WikilambdaDiff to restrict access
 ResolvedgenghT321186 Discuss and decide all areas for restricted access (high granularity)
 ResolvedgenghT321184 Implement user authorization base classes and one POC
 ResolvedgenghT299606 Restrict users from creating top-level ZObjects of inappropriate types
 ResolvedDVrandecicT266239 Determine which types are allowed to be created as top level objects
 ResolvedmaryyangT285312 Enable Logging in Backend Services
 ResolvedcmassaroT287090 Improve Logging in Executors by Not Relying on stderr for Error Reporting
 ResolvedoriT290700 Use a Proper Logging Module in Orchestrator
 ResolvedcmassaroT338273 Implement Map, Reduce, and Filter as pre-defined, built-in functions
 ResolvedcmassaroT315649 Execution of Z885( Z511 ) fails
 ResolvedJdforrester-WMFT303335 Users can understand the nature of changes others have made to ZObject wiki content
 ResolvedJdforrester-WMFT339348 Users have a raw diff of the JSON when changes have been made
 ResolvedJdforrester-WMFT282913 Implement agreed security and control measures in the Wikifunctions system
 ResolvedJdforrester-WMFT278651 Add rate limits and rights for each part of the system
 ResolvedJdforrester-WMFT282914 Provide user rights for editing of ZObjects at all, and specific ones for ZImplementations, ZTesters, and ZFunctions
 ResolvedoriT282921 Implement per-user request rate limits in the orchestrator
 ResolvedNoneT261470 Sandboxing and monitoring of evaluations
 ResolvedcmassaroT282923 Provide a mechanism by which sysadmins can easily disable/re-enable specific language evaluators from Wikifunctions
 ResolvedcmassaroT323049 Consider Propagating Remaining Time among Orchestrator and Evaluator Processes
 ResolvedcmassaroT323046 Implement per-request timeout / resource consumption limits in the evaluator
 ResolvedcmassaroT326785 Kubernetes Wikifunctions security and control measures
 ResolvedDMartin-WMFT287429 New pre-defined built-in function: Z8xx/Get envelope from Function call
 ResolvedDMartin-WMFT287428 New pre-defined built-in function: Z828/Get Metadata about Persistent Object
 DuplicateNoneT290215 Provide a built-in that takes a Z9/Reference and returns the Z2/Persistent Object
 ResolvedDMartin-WMFT290216 Add definition for pre-defined Z804/Get key references from object and its built-in implementation Z904
 ResolvedcmassaroT294452 Provide a 'map' type (object -> object)
 ResolvedcmassaroT304097 Allow Z883/Typed Map to accept Z39/Key reference objects as well as Z6/String objects
 ResolvedBUG REPORT• AdesojiThisDotT298716 Calls to functions should name and link the function they're calling but do not (regression?)
 ResolvedJdforrester-WMFT314485 We are ready for the last three phases, especially the next, ι (Iota)
 ResolvedAAlhazwani-WMFT303323 Prepare all design work for implementation in Phase Iota
 ResolvedDMartin-WMFT303345 Function, Implementation, and Tester meta-data is emitted and displayed to users
 ResolvedDMartin-WMFT303346 Measure and display to the user how much wall time is used in evaluating a ZObject
 ResolvedDMartin-WMFT303347 Measure and display to the user how much CPU time is used in evaluating a ZObject
 ResolvedDMartin-WMFT303348 Measure and display to the user how much memory is used in evaluating a ZObject
 ResolvedaishwaryavardhanaT303349 Design the manner in which meta-data is displayed to users
 ResolvedDMartin-WMFT303350 Display meta-data to users alongside the ZObject to which it refers
 ResolvedDMartin-WMFT282164 Change the orchestrator to return status tuples with non-metric metadata (success, error list, …)
 ResolvedDMartin-WMFT295496 Add warnings to the Z22/Function call result type
 ResolvedJdforrester-WMFT309642 Update Z820 / Trigger metadata to work with maps
 ResolvedDMartin-WMFT291136 Migrate orchestrator/evaluator responses to reply with result envelopes including meta-data map type
 DeclinedDVrandecicT289796 Function model: Create a type for a return value/meta-data blob
 ResolvedJdforrester-WMFT307483 Consider providing a PHP implementation of ZMap for ease of manipulation
 ResolvedDMartin-WMFT313567 Provide a wiki page documenting function call metadata
 ResolvedDMartin-WMFT319331 Add help link to metadata dialogs
 ResolvedDMartin-WMFT316567 Check if results are ready before showing info-icons for tester runs
 ResolvedDMartin-WMFT314960 Add some environment meta-data to the response envelope
 ResolvedDMartin-WMFT310199 Select fastest correct implementation
 ResolvedDMartin-WMFT319478 When a Tester runs for a Function's Implementations, automatically re-order the list of Implementations in correctness and speed order
 ResolvedDVrandecicT324802 Phase θ Goal 5: Fallback view
 ResolvedBUG REPORTTeleosteenT321901 ZObjectSelector: throws a console error on the typeUrl function
 ResolvedBUG REPORT• AdesojiThisDotT323055 ZLabelsBlock: Saving and loading empty string aliases
 Resolved• JKiesermanT315099 zObject creation: errors / blockers to saving are not surfaced well or at all
 Resolved• SWoodruff-WMFT315002 Error handling in the front-end after returning the response for every API
 Resolved• JKiesermanT320269 Don't disable buttons on failed validation, instead, surface errors and highlight missing fields when button is clicked
 Resolved• JKiesermanT321401 Catch missing ZTester and ZImplementation properties with FE error management
 Resolved• JKiesermanT321404 update cdx-text-input to use native codex error state as part of FE error management
 InvalidNoneT321623 modify error message system to accomodate links and special formatting
 ResolvedDdwaalT321381 Publish component: Create a publish component used in all Wikifunctions create and edit pages
 ResolvedDdwaalT321739 Handle shouldUnattachImplementationTester passed to this.submitZObject in the PublishDialog
 ResolvedDdwaalT321741 Add a success snackbar to the redirect page after successful zObject creation.
 ResolvedDdwaalT321742 Replace mock data with error data from the store
 InvalidDdwaalT321743 Trigger check for error warnings in ZObjectPublish
 ResolvedDdwaalT321744 Make the publish component mobile friendly
 InvalidDdwaalT322265 Look into linking to implementation and tester page on warning
 ResolvedgenghT317556 Design and implement: evaluate a function
 Resolvedallanjeremy.thisdotT334377 DefaultView Widgets: Create a Function Explorer widget for the implementation page
 ResolvedgenghT339956 Fix default view regressions after merging the typed list component
 ResolvedBUG REPORTgenghT339876 About widget: When create new page, Name/Labels field doesn't show "Untitled"
 ResolvedDVrandecicT298176 Review Special pages and API modules
 ResolvedJdforrester-WMFT298175 Create and implement naming convention for API and Special pages
 ResolvedJdforrester-WMFT285548 Update API documentation with new endpoints
 ResolvedSDunlapT276847 Write a suite of user experience end-to-end integration tests for WikiLambda in selenium/etc. sufficient for us to launch with
 ResolvedTeleosteenT321932 E2E test for CUJ 1: Evaluate a function
 ResolvedTeleosteenT321933 E2E test for CUJ 2: Create a function definition
 ResolvedDVrandecicT318930 CUJ 2: Create a function definition
 ResolvedDVrandecicT323804 Design: create a function definition
 ResolvedDdwaalT321399 Don't show / disable the "show more languages" / "Show name in other languages" buttons when there aren't any to show
 ResolvedDdwaalT321396 Copy: Evaluate copy on function viewer details tab
 ResolvedNik.xyz.inT321934 E2E test for CUJ 3: Edit a function definition
 ResolvedDVrandecicT318933 CUJ 3: Edit a function definition
 ResolvedDVrandecicT318314 Function editor: Remove an item from the list of arguments
 Resolved• AdesojiThisDotT318315 Function editor: Implement functionality of "remove input field" using the Mobile view button.
 ResolvedDdwaalT318317 Function editor: Implement "remove input field" button for Desktop view
 ResolvedAAlhazwani-WMFT312121 The dropdown menu of the "output type" from the function definition page is hidden under another component
 ResolvedNoneT323805 Design: edit a function definition
 ResolvedaishwaryavardhanaT285418 A way to easily and intuitively create and edit functions
 ResolvedaishwaryavardhanaT285419 Initial user flow diagrams for function editor
 InvalidaishwaryavardhanaT285421 Generative design research: Testing of new hypotheses and mental models
 Declined• SWoodruff-WMFT285422 Function editor: User education, interface copy, notifications and alerts
 Declined• SWoodruff-WMFT285684 As someone who is new to creating functions, I would like to be able to start with an easy task
 ResolvedaishwaryavardhanaT296693 Desktop designs for function editor v1
 Resolved• AdesojiThisDotT297086 Function Editor - Sidebar - Language selector
 Declined• AdesojiThisDotT298203 Provide an easy way on the front-end for Wikifunctions to know what languages are supported (and what their ZIDs are)
 ResolvedSimoneThisDotT297095 Function Editor - Function Definition - New component
 Resolved• JKiesermanT297098 Function Editor - Function definition - Heading
 Resolved• AdesojiThisDotT297099 Function Editor - Enhance the "Object selector" to allow user to type within its first entry instead than the input itself to align with the designs
 ResolvedSimoneThisDotT297100 Function Editor - Create the function definition main content area
 Resolved• AdesojiThisDotT297101 Function Editor - Allow user to add labels in another language in function definition
 Resolved• JKiesermanT297104 Function Editor - Provide the ability for users to publish, write implementation and cancel function
 Resolved• JKiesermanT297271 Function Editor - Create an Chip component
 Resolved• AdesojiThisDotT297280 Function Editor - sidebar - Update diagram
 ResolvedgenghT297869 Function Editor: Allow user to REMOVE an Input from a function definition
 ResolvedSimoneThisDotT298464 Remove old function editor and its files
 ResolvedaishwaryavardhanaT296698 Provide a UX design for function viewing
 ResolvedSimoneThisDotT301518 Explore replacing the legacy function editor with fallback to the generic editor via a button, so that functions can be connected to implementations and testers and we can scrap the legacy function editor
 ResolvedaishwaryavardhanaT296694 Mobile designs for function editor v1
 ResolvedaishwaryavardhanaT296696 Provide a compelling, scalable, validated UX design for function creation and editing
 ResolvedaishwaryavardhanaT297458 User flow for when a user edits definition
 ResolvedaishwaryavardhanaT297462 User flow when a user only edits labels
 ResolvedaishwaryavardhanaT297463 User flow for how a user would complete multilingual edits
 ResolvedNoneT297464 Decide on the UX design for the edit summary
 ResolvedaishwaryavardhanaT297465 Design notes for if an input type is changed
 ResolvedaishwaryavardhanaT297466 Design notes for if an output type is changed
 ResolvedaishwaryavardhanaT297467 Decide on the UX design for attaching and detatching (but not editing) implementations and testers
 ResolvedaishwaryavardhanaT297668 Revisit user flows for function editor
 Resolved• SWoodruff-WMFT318316 Function editor: Design function argument (input) delete button/icon for Desktop view.
 ResolvedAAlhazwani-WMFT320410 Design: Function editor, redefine separation between fields and blocks.
 ResolvedAAlhazwani-WMFT270304 Design a "Publish" component
 ResolvedSimoneThisDotT268296 Display to user why an object is not stored
 DuplicateNoneT274424 Show errors if creation of ZObject fails
 ResolvedDVrandecicT316686 Copy: change text for confirmation dialog when creating a new function on mobile
 ResolvedDVrandecicT303336 Users can write an edit summary when publishing which can be seen by other users in histories
 ResolvedDVrandecicT299004 Have the publish function enable/disable itself only if there have been changes
 ResolvedgenghT326656 FunctionEditor: Implement separation between fields and blocks changes
 ResolvedNik.xyz.inT321935 E2E test for CUJ 4: Create tester for function
 ResolvedDVrandecicT318938 CUJ 4: Create tests
 InvalidNoneT323806 Design: create tests
 ResolvedNik.xyz.inT321937 E2E test for CUJ 5: Create implementations with code
 ResolvedNik.xyz.inT321939 E2E test for CUJ 6: Connect an implementation or test to a function
 ResolvedDVrandecicT318936 CUJ 6: Connect an implementation or test to a function
 ResolvedDVrandecicT323808 Design: connect an implementation or test to a function
 ResolvedDdwaalT320278 Copy: Language for "connecting" an implementation or tester to a ZFunction
 ResolvedDdwaalT318426 Tests: Implement FE integration test for connecting implementations and testers to functions
 ResolvedSDunlapT321942 make E2E test suit runnable via "helm test"
 ResolvedNik.xyz.inT321938 E2E test for CUJ 5: Create implementations with composition
 ResolvedNik.xyz.inT318939 CUJ 5: Add implementations via code or composition
 InvalidNoneT323807 Design: add implementations via code or composition
 Resolved• CCoxwell-WMFT290522 Object model: Add short description to Z2/Persistent Objects, Z2K5
 Resolved• CCoxwell-WMFT335360 Provide short description (Z2K5) view/editing in function views, not just default views
 ResolvedAAlhazwani-WMFT303229 Create a design for having short descriptions on function pages

Event Timeline

aishwaryavardhana created this task.Mar 7 2022, 9:47 PM
Restricted Application added a subscriber: Aklapper. · View Herald TranscriptMar 7 2022, 9:47 PM
Maintenance_bot added a project: Abstract Wikipedia team.Mar 7 2022, 10:46 PM
DVrandecic moved this task from To triage to To triage: Nice-to-haves on the Abstract Wikipedia team board.Mar 8 2022, 5:15 PM
DVrandecic moved this task from To triage: Nice-to-haves to Phase θ – Throttling on the Abstract Wikipedia team board.
DVrandecic edited projects, added Abstract Wikipedia team (Phase θ – Throttling); removed Abstract Wikipedia team.
Jdforrester-WMF renamed this task from Documentation on function page to Create a design for having documentation on function pages.Mar 8 2022, 7:55 PM
Jdforrester-WMF added a parent task: T303323: Prepare all design work for implementation in Phase Iota.
Jdforrester-WMF removed a project: WikiLambda Front-end.Mar 10 2022, 3:00 PM
Jdforrester-WMF subscribed.

This is a make-a-design task not an implement-a-design task.

Jdforrester-WMF triaged this task as Medium priority.Apr 19 2022, 4:53 PM
Jdforrester-WMF moved this task from Incoming to Ready: G8. Ready for Iota on the Abstract Wikipedia team (Phase θ – Throttling) board.
AAlhazwani-WMF subscribed.Aug 3 2022, 12:55 PM

Duplicate of T304904: Create a design for having and interacting with multi-lingual documentation on ZObject pages

AAlhazwani-WMF closed this task as Invalid.Aug 3 2022, 12:55 PM
AAlhazwani-WMF removed aishwaryavardhana as the assignee of this task.
Jdforrester-WMF closed this task as a duplicate of T304904: Create a design for having and interacting with multi-lingual documentation on ZObject pages.Aug 3 2022, 1:30 PM
Jdforrester-WMF renamed this task from Create a design for having documentation on function pages to Create a design for having short descriptions on function pages.Jun 5 2023, 8:06 PM
Jdforrester-WMF reopened this task as Open.
Jdforrester-WMF updated the task description. (Show Details)

Re-purposing.

Jdforrester-WMF added a parent task: T290522: Object model: Add short description to Z2/Persistent Objects, Z2K5.Jun 5 2023, 8:06 PM
Jdforrester-WMF moved this task from Phase θ – Throttling to Phase λ – Launch on the Abstract Wikipedia team board.Jun 16 2023, 8:50 AM
Jdforrester-WMF edited projects, added Abstract Wikipedia team (Phase λ – Launch); removed Abstract Wikipedia team (Phase θ – Throttling).
Jdforrester-WMF moved this task from Incoming to Engineering tasks on the Abstract Wikipedia team (Phase λ – Launch) board.Jun 16 2023, 8:55 AM
AAlhazwani-WMF claimed this task.Jun 19 2023, 9:21 AM
AAlhazwani-WMF updated the task description. (Show Details)Jun 19 2023, 11:48 AM
AAlhazwani-WMF removed a subscriber: aishwaryavardhana.
AAlhazwani-WMF moved this task from Engineering tasks to In progress on the Abstract Wikipedia team (Phase λ – Launch) board.Jun 19 2023, 1:02 PM
AAlhazwani-WMF updated the task description. (Show Details)Jun 19 2023, 1:41 PM
Jdforrester-WMF edited parent tasks, added: T335360: Provide short description (Z2K5) view/editing in function views, not just default views; removed: T290522: Object model: Add short description to Z2/Persistent Objects, Z2K5.Jun 20 2023, 3:39 PM
DVrandecic subscribed.Jun 20 2023, 5:05 PM

Just one question: the function evaluation widget is in a very non-prominent spot in the last design. Can we increase its prominence? Either by putting it at the top or having it in the right-hand column (if function definitions have a right hand column).

Everything else: approved

Jdforrester-WMF closed this task as Resolved.Jun 20 2023, 5:12 PM
Jdforrester-WMF moved this task from In progress to Complete on the Abstract Wikipedia team (Phase λ – Launch) board.

I've created T339954: Function view: Alter the design to drop the tabs, and instead use a single-column view like other pages to track the bigger work. Let's continue that discussion there and call this one Resolved.

gerritbot added a comment.Jun 29 2023, 4:25 PM

Change 934378 had a related patch set uploaded (by Ccoxwell; author: Ccoxwell):

[mediawiki/extensions/WikiLambda@master] [WIP] Function View Description

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

gerritbot added a project: Patch-For-Review.Jun 29 2023, 4:25 PM
gengh mentioned this in T339954: Function view: Alter the design to drop the tabs, and instead use a single-column view like other pages.Dec 13 2023, 2:35 PM
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