Thanks to visit codestin.com
Credit goes to github.com

Skip to content

[Docs][Forms] Updating Forms docs #9038

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 7 commits into from
Sep 25, 2025
Merged

[Docs][Forms] Updating Forms docs #9038

merged 7 commits into from
Sep 25, 2025

Conversation

JoseLuisGJ
Copy link
Contributor

@JoseLuisGJ JoseLuisGJ commented Sep 18, 2025 •
edited
Loading

Summary

Some form inputs were redesigned as a part of the new Borealis visual refresh. The Figma library also was updated to sync with this changes and now the documentation should by aligned with these changes. These are the main changed:

  • Forms section now has a specific page to #summarise and redirect to the subcomponents Not in this PR. We'll work on a pitch for this change in a separated PR
CleanShot 2025-09-22 at 14 07 59@2x
  • Form validation content has been merged and moved to Form layouts
  • Form guidelines renamed as Usage
CleanShot 2025-09-22 at 14 08 30@2x
  • Form controls guidelines now is a reusable resource that is embedded on each Form component that needs to convey this info under the title of Usage
CleanShot 2025-09-22 at 14 09 14@2x

Why are we making this change?

Related issue ticket: https://github.com/elastic/platform-ux-team/issues/729

Screenshots #

Forms page:

Impact to users

QA

Remove or strikethrough items that do not apply to your PR.

General checklist

  • Browser QA
    • Checked in both light and dark modes
    • Checked in both MacOS and Windows high contrast modes
    • Checked in mobile
    • Checked in Chrome, Safari, Edge, and Firefox
    • Checked for accessibility including keyboard-only and screenreader modes
  • Docs site QA
  • Code quality checklist
  • Release checklist
    • A changelog entry exists and is marked appropriately.
    • If applicable, added the breaking change issue label (and filled out the breaking change checklist)
  • Designer checklist
    • If applicable, file an issue to update EUI's Figma library with any corresponding UI changes. (This is an internal repo, if you are external to Elastic, ask a maintainer to submit this request)

@JoseLuisGJ JoseLuisGJ added documentation Issues or PRs that only affect documentation - will not need changelog entries skip-changelog Use on PRs to skip changelog requirement (Don't delete - used for automation) labels Sep 18, 2025
@JoseLuisGJ JoseLuisGJ self-assigned this Sep 18, 2025
@JoseLuisGJ JoseLuisGJ marked this pull request as ready for review September 18, 2025 15:33
@JoseLuisGJ JoseLuisGJ requested a review from a team as a code owner September 18, 2025 15:33
weronikaolejniczak
weronikaolejniczak reviewed Sep 19, 2025
View reviewed changes
@weronikaolejniczak
Copy link
Contributor

⚠️ There are some unresolved link warnings:

[WARNING] Docs markdown link couldn't be resolved: (../../forms/validation/basic.mdx) in source file "/Users/weronikaolejniczak/Projects/eui/packages/website/docs/components/editors-and-syntax/markdown/editor.mdx" for version current
[WARNING] Docs markdown link couldn't be resolved: (../validations.mdx) in source file "/Users/weronikaolejniczak/Projects/eui/packages/website/docs/components/forms/layouts/guidelines.mdx" for version current

No need to fix all of the console warnings. I do that on: #8814 Just the ones that are related to the changes.

weronikaolejniczak
weronikaolejniczak reviewed Sep 19, 2025
View reviewed changes
packages/website/docs/components/forms/index.mdx Outdated
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I believe we decided not to have these "Overview" pages that are also a section toggle.

@acstll do I remember correctly? 🤔

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There are 2 more first level pages like this proposal, Data Grid and Tables have also a dedicated page. I see the benefits it can give but I also agree this is more content we add. Let me know if we want to remove any first level entry point content or it's a pattern we can use.

@weronikaolejniczak
Copy link
Contributor

Do we want the "Guidelines" page? "Guidelines" should be renamed to "Usage", right?

Screenshot 2025-09-19 at 11 14 34

@weronikaolejniczak
Copy link
Contributor

@JoseLuisGJ

  • The "Forms" redirection on the homepage doesn't work. It's not included in the warnings because it's not hooked up to the Docusaurus broken links resolution.
Screenshot 2025-09-22 at 14 38 18 Screenshot 2025-09-22 at 14 43 12 Screenshot 2025-09-22 at 14 45 59 Screenshot 2025-09-22 at 14 39 16

As for the "Forms" overview page - personally, even if there are such pages, I would not do it. The overview page repeats what the navigational structure represents. But ofc this is just my opinion, I trust your judgement 😄 Let's wait for someone else to chime in with thoughts as well (like @acstll).

@JoseLuisGJ
Copy link
Contributor Author

JoseLuisGJ commented Sep 24, 2025 •
edited
Loading

Hey @weronikaolejniczak as discussed we decided to remove the addition of the index.mdx page to the Forms section from this PR. This proposal will be tackled in a different ticket.

@elasticmachine
Copy link
Collaborator

💚 Build Succeeded

History

cc @JoseLuisGJ

@elasticmachine
Copy link
Collaborator

elasticmachine commented Sep 24, 2025 •
edited
Loading

💚 Build Succeeded

History

cc @JoseLuisGJ

weronikaolejniczak
weronikaolejniczak approved these changes Sep 25, 2025
View reviewed changes
Copy link
Contributor

@weronikaolejniczak weronikaolejniczak left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for the ping, @JoseLuisGJ! That's a good call!

All's good 🟢 we can merge 🚀

@JoseLuisGJ JoseLuisGJ merged commit 3bec27d into elastic:main Sep 25, 2025
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@weronikaolejniczak weronikaolejniczak weronikaolejniczak approved these changes

Assignees

@JoseLuisGJ JoseLuisGJ

Labels

documentation Issues or PRs that only affect documentation - will not need changelog entries skip-changelog Use on PRs to skip changelog requirement (Don't delete - used for automation)

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@JoseLuisGJ @weronikaolejniczak @elasticmachine