Page MenuHomePhabricator

Wiki creation workflow is hard to understand when domains are too short + copy fixes
Closed, ResolvedPublic

Assigned To
Authored By
Mattia_Capozzi_WMDE
Feb 9 2022, 6:46 PM
Referenced Files
F57731470: image.png
Nov 22 2024, 11:33 AM
F57319550: grafik.png
Aug 28 2024, 9:02 AM
F57319510: grafik.png
Aug 28 2024, 9:02 AM
F57319486: grafik.png
Aug 28 2024, 9:02 AM
F57319480: grafik.png
Aug 28 2024, 9:02 AM
F57294861: grafik.png
Aug 26 2024, 1:51 PM
F57294761: grafik.png
Aug 26 2024, 1:03 PM
F57294754: grafik.png
Aug 26 2024, 1:00 PM

Description

Link ro Figma file

1. Site name creation

When creating a wiki on wikibase our UI currently states that "The domain must be at least 20 characters". This is technically correct but given that the user can only pick the subdomain it's not that clear.

image.png (82×548 px, 6 KB)

Instead we should add the hint prop to the text input component that appears whenever the component is in focus. To see the correct behavior, please look at the examples provided in the vuetify docs or our implementation of the "How to reach you"-field in our contact form

grafik.png (540×1 px, 47 KB)

The copy for the hint should read:
The subdomain must be at least five characters long and may contain only lowercase Latin letters (a-z), digits (0-9) and hyphens (-).

grafik.png (316×1 px, 46 KB)

The error text should be the same as the hint text.

grafik.png (310×1 px, 48 KB)

[Please note: I recreated the component in figma since my library didn't include the exact style I needed. Please disregard any discrepancy between my design and the actual look of the vuetify component]

2. Various copy fixes in the form and tooltip

a. tooltip

current

grafik.png (408×2 px, 177 KB)

New copy:
A domain name is what people type into their browser to visit your site.
If you own your own domain, you can use it for Wikibase Cloud by selecting "Custom Domain".
Otherwise, choose your own name to be a subdomain of wikibase.cloud (five characters minimum, only a-z, 0-9 and "-") by selecting "Free Subdomain".  Example: your-name-here1.wikibase.cloud

b. various copy changes in form

grafik.png (1×1 px, 192 KB)

(all text marked are areas with altered copy)

Patches:

Event Timeline

Tarrow renamed this task from Characters length mismatching to Wiki creation workflow is hard to understand when domains are too short.Feb 23 2022, 8:58 PM
Tarrow updated the task description. (Show Details)

Moved out of the launch backlog as it was decided today this should 100% not block launch

This probably just needs some better text from the UX side of things, and should be a very easy fix

New text was already done in T306868 for hovering, but not for errors yet it seems.

The error text should be: Please enter at least 5 characters.

It seems like the ticket that adam linked was a suboptimal fix for the problem at hand. My suggestion would be to add the copy from the original ticket using the hint prop.

Copy suggestion: "The subdomain must be at least five-character long, and can consist of small Latin letters, digits and hyphens."

The error message when trying to save without following the requirements should be exactly the same as the hint. If the decision is made against including the hint prop, the error message should still be the above copy.

I would also reccomend removing the copy from the info popover (as was implemented in the other ticket T306868 ) as that is not the correct location for that information, though it is just causing clutter and not impacting any workflows negatively I would assume. Would just make sense to clean things up while the code is being edited anyway.

Ideally we would be doing real-time validation instead of only server side validation but that's probably for another ticket.

Hey @danshick-wmde would you mind checking the copy of the tooltip of which I included a screenshot in the ticket description (last image). This is the tooltip that is currently showing when hovering over the info-icon of Site-Domain in the form to create a new wikibase instance

grafik.png (1×796 px, 95 KB)

We're planning to remove the last sentence and add it as a hint to the respecitve text input field instead to provide contextual help.

But we are wondering about the rest of the tooltip. Does the english sound okay to you? Do you think the message serves its purpose (explaining to users what this section of the form is about and helping them chose the right option for themselves)?

grafik.png (302×1 px, 78 KB)

Thanks!

Hi there,

@Anton.Kokh sent me this task in Mattermost, and I made suggestions here:

https://app.asana.com/0/1201386595963522/1208155648650634/f

I realize nobody knows how to send me work :) I'm working on a solution to that right now. Until then feel free to use Phabricator or Asana. Ideally any text to be edited should appear in text form (as opposed to my having to transcribe a screenshot).

Adding info on the rest of the text:

  • e.g. is never capitalized and always followed by a comma.
  • I recommend sentence-style capitalization ("Site name", "Site domain") and not headline-style ("Site Name", "Site Domain").
  • I recommend never capitalizing "wiki".

@Charlie_WMDE Could you please update the task description in line with Dan's recommendations from the Asana task and last comment?
Thank you!

Charlie_WMDE renamed this task from Wiki creation workflow is hard to understand when domains are too short to Wiki creation workflow is hard to understand when domains are too short + copy fixes.Aug 28 2024, 9:02 AM
Charlie_WMDE updated the task description. (Show Details)
Charlie_WMDE updated the task description. (Show Details)

@Anton.Kokh done. ticket should be ready to go

@Anton.Kokh should we also change "Your User" to "Your user" and "Terms of Use" to "Terms of use"?

@Anton.Kokh should we also change "Your User" to "Your user" and "Terms of Use" to "Terms of use"?

I'm not Anton, but I think you are right about those changes

Tarrow changed the task status from Open to Stalled.Nov 20 2024, 9:07 AM

Hey @Andrew-WMDE

  1. validation: currently the domain input field gets validated after the terms of use. I can input an invalid domain name and click CREATE WIKI and the error I get is for the terms of use checkbox. Only once that is selected, I get an error in the domain name input field. (see screenshot)
    image.png (1×794 px, 103 KB)
    Would it be possible, to do the validation in order of the components?
  1. max-width if the tooltip: Seeing the new tooltip size made me realise that I forgot to include a max-width for the tooltip. Could you make that 448px?
  1. Terms of use still has a capital U
  1. The suffix (.wikibase.cloud) is gone on the site domain input component. Could you restore that?

Thanks!

Hey @Andrew-WMDE

  1. validation: currently the domain input field gets validated after the terms of use. I can input an invalid domain name and click CREATE WIKI and the error I get is for the terms of use checkbox. Only once that is selected, I get an error in the domain name input field. (see screenshot)
    image.png (1×794 px, 103 KB)
    Would it be possible, to do the validation in order of the components?

Checking whether or not a domain is valid is done server-side, which happens after the form is submitted to our servers. Verifying that the user accepted our "Terms of Use" occurs before anything is submitted. Modifying this behavior is sort of out of scope for this ticket.

  1. max-width if the tooltip: Seeing the new tooltip size made me realise that I forgot to include a max-width for the tooltip. Could you make that 448px?

Done

  1. Terms of use still has a capital U

If I'm not mistaken, "Terms of Use" in the sentence is acting as a proper noun, so it should be capitalized.

  1. The suffix (.wikibase.cloud) is gone on the site domain input component. Could you restore that?

It looks like this was only missing from Netlify previews and is now resolved.

Thanks!

Hey @Andrew-WMDE

  1. validation: currently the domain input field gets validated after the terms of use. I can input an invalid domain name and click CREATE WIKI and the error I get is for the terms of use checkbox. Only once that is selected, I get an error in the domain name input field. (see screenshot)
    image.png (1×794 px, 103 KB)
    Would it be possible, to do the validation in order of the components?

Checking whether or not a domain is valid is done server-side, which happens after the form is submitted to our servers. Verifying that the user accepted our "Terms of Use" occurs before anything is submitted. Modifying this behavior is sort of out of scope for this ticket.

fair enough, then lets leave it as is 👍

  1. max-width if the tooltip: Seeing the new tooltip size made me realise that I forgot to include a max-width for the tooltip. Could you make that 448px?

Done

  1. Terms of use still has a capital U

If I'm not mistaken, "Terms of Use" in the sentence is acting as a proper noun, so it should be capitalized.

Sorry, I was just going off of your previous comment without double checking. If you think the capital U is correct, then let's keep it.

  1. The suffix (.wikibase.cloud) is gone on the site domain input component. Could you restore that?

It looks like this was only missing from Netlify previews and is now resolved.

👍

Thanks!

coolio. then this is read to go!

Andrew-WMDE changed the task status from Stalled to Open.Dec 3 2024, 11:23 AM