Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add helpful descriptions and examples to every field in the declarative_component_schema #23837

Closed
lmossman opened this issue Mar 7, 2023 · 4 comments
Assignees

Comments

@lmossman
Copy link
Contributor

lmossman commented Mar 7, 2023

Context

We would like to show more helpful tooltips in the Connector Builder, instead of the brief descriptions that are currently hardcoded into the webapp.

In order to keep these descriptions close to the implementation so that they don't get out of sync with the field structure, these descriptions should be added to the declarative_component_schema.yaml

Acceptance criteria:

  • Every field in the declarative_component_schema has each of the following:
    • title - a human-readable title that can be displayed in the builder as the label for that input
    • description - a helpful description explaining what the field is, why a user may want to use it, what the consequences of setting it are, etc.
    • examples - an array of example values that can be displayed in the tooltip, similar to the examples provided in connector specs
  • The above descriptions are reviewed by the docs team / solutions engineering to ensure they are clear and helpful
@lmossman
Copy link
Contributor Author

lmossman commented Mar 14, 2023

Grooming notes:

  • A lot of the python code already has these descriptions, so that can be used as a basis
  • @lmossman to add guidance on max length of descriptions

@girarda
Copy link
Contributor

girarda commented Mar 30, 2023

feedback from last build a connectors session:

Update Path URL tooltip to make it clear that user inputs are safe to use, just can’t hardcode actual secret values there

@brianjlai
Copy link
Contributor

Doc for guidelines and the process for updating the schema documentation:
https://docs.google.com/document/d/1L0IZwiDL_NVHU_TwehZZgptoE_U0t1ppNAqu0D-7j1I/edit#heading=h.ze9rfx2mih7s

@flash1293
Copy link
Contributor

Done and merged

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants