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

[Docs] Add this guidance for handling required / optional form fields #8268

Open
JasonStoltz opened this issue Jan 10, 2025 · 1 comment
Open
Assignees
Labels
documentation Issues or PRs that only affect documentation - will not need changelog entries low hanging fruit An issue, often a bug, that is lower effort and clearly ought to be fixed

Comments

@JasonStoltz
Copy link
Member

JasonStoltz commented Jan 10, 2025

elastic/kibana#195048 (comment)

@MichaelMarcialis Mentioned this guidance, but I don't think we ever added it to our docs. We should take a few minutes to add it. It doesn't need to be perfect, but it's better than not having anything.

This seems like an appropriate place to add it: https://eui.elastic.co/#/forms/form-layouts/guidelines

There's a very brief mention:

Use labels and descriptions
Use a label (and description if needed) for each form field. All form fields should be considered required unless stated alongside the label.

Unfortunately, this guidance is super buried in the docs today. Hopefully in EUI+ we could make it more prominent.,

@JasonStoltz JasonStoltz added low hanging fruit An issue, often a bug, that is lower effort and clearly ought to be fixed documentation Issues or PRs that only affect documentation - will not need changelog entries labels Jan 10, 2025
@MichaelMarcialis
Copy link
Contributor

CCing @joana-cps, as she showed interest in getting it added to our guidelines docs. Also happy to help if time/priorities permit.

@joana-cps joana-cps self-assigned this Jan 14, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Issues or PRs that only affect documentation - will not need changelog entries low hanging fruit An issue, often a bug, that is lower effort and clearly ought to be fixed
Projects
None yet
Development

No branches or pull requests

3 participants