Page MenuHomePhabricator

Community Configuration edit form should allow section anchoring
Open, Needs TriagePublic

Description

User story & summary:

As a Wikimedian, I want to link to a specific section within Community Configuration, so that I can discuss it or suggest a configuration change.

Background & research:

This task is important because the Community Configuration PRD includes this requirement:

Ability to link to a certain section within the configuration page.

  • This is important for admins and community members discussing configuration.
  • This is important for Wikimedia developers and WMF teams when rolling out new configuration settings.
Design:

Figma designs

Linking to certain sections within the form should be simple, giving we make use of a table of contents that uses links to navigate to the different sections. Since most of our forms are short and don't require much scrolling, I suggest that for now, we keep it simple with only linking to sections with the help of the TOC.

For forms that are long, like the Suggested Edits one, we can have sub-sections within sections that are also linkable, example:

Group 5255.png (611×1 px, 144 KB)

This should mimic the same UX Wikimedians are familiar with:
Example: https://www.mediawiki.org/wiki/Community_configuration#Design

Acceptance Criteria:

Given I'm accessing a Community Configuration edit form,
When I want to link to a particular section,
Then I can click on the section name in the TOC and the URL will then include an anchor for that section

Event Timeline

I believe the TOC as it is displays "sections" or "groups" of configurations, we won't have support for grouping configs until we solve T358221. Should we postpone this task until we complete the other or change design? @KStoller-WMF

From the engineering POV, is the left target area to display the menu an area where we could use Vue.js? @Esanders @Catrope

I believe the TOC as it is displays "sections" or "groups" of configurations, we won't have support for grouping configs until we solve T358221. Should we postpone this task until we complete the other or change design? @KStoller-WMF

We can postpone this task to "Post MVP". We should support this in the future, but it isn't supported in EditGrowthConfig, so it definitely shouldn't block the initial release.