Contrib.social

D7: Add more help text for Quant API tab fields

Open on Drupal.org →
Created on 13 June 2023, over 1 year ago
Updated 27 June 2023, over 1 year ago

Problem/Motivation

It's not always clear to users what to paste into the fields on the API tab.

A customer reported they weren't sure how to fill in the API form because it said "API Customer" and they hadn't looked at the Integrations page in the dashboard. They also weren't sure what to put in for the project because they had different text that was similar.

Steps to reproduce

Install quant_api module and go to Quant's API tab:

  • D7: /admin/config/services/quant/api
  • D9+: /admin/config/development/quant/api

Proposed resolution

Add more help text that makes it more clear where to get the API information to paste in from the dashboard.

The correct values are easiest to grab from the “integrations” page of the dashboard — which will give you the machine name for the organization, project, and token value.

Remaining tasks

  1. Figure out text
  2. Update code
  3. Review and test
  4. Commit :)

User interface changes

Clearer instructions for the API tab fields.

API changes

Data model changes

📌 Task
Status

Fixed

Version

1.0

Component

Documentation

Created by

🇺🇸United States Kristen Pol Santa Cruz, CA, USA

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

Comments & Activities

contrib.social Blog FAQ Discussions
Production build 0.71.5 2024