Provide a form description for KeyInput forms

Created on 18 December 2019, over 5 years ago
Updated 24 April 2025, 3 days ago

Problem/Motivation

I install the module and go to add a username/password key. At the bottom of the page I get a cryptic form element "Key value" without a description. Maybe this is obvious to some people what the expected value is, but I don't think it is obvious.

Is the format "username=value"? Is it "username|value"? Is it "username value"? Are the values comma separated? Line break separated? Is this even used for a username and password at the same time? The documentation pages aren't clear on this either.

Proposed resolution

  1. Add a #description to KeyInput plugins that describe to the user the expected value.
  2. Adding validation to the KeyInput plugin forms would also help reduce the complexity and confusion of the interface by providing clear errors before the key is in-use.

Remaining tasks

User interface changes

📌 Task
Status

Needs review

Version

1.0

Component

Documentation

Created by

🇺🇸United States mradcliffe USA

Live updates comments and jobs are added and updated live.
Sign in to follow issues

Merge Requests

Comments & Activities

Not all content is available!

It's likely this issue predates Contrib.social: some issue and comment data are missing.

Production build 0.71.5 2024