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.

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

chore(forms): Extended features docs #2978

Merged
merged 7 commits into from
Dec 8, 2023
Merged

chore(forms): Extended features docs #2978

merged 7 commits into from
Dec 8, 2023

Conversation

henit
Copy link
Contributor

@henit henit commented Dec 6, 2023

Doing the following (inside the Forms-extension):

  • Rewrite Extended feature page with sections instead of automatic component lists
  • Moving DataContext and Value from "Create your own component" to "Extended features"
  • Moving Field from "Create your own component" to a separate menu item above the field components in the left menu
  • Remove duplicated list of components between the Field page and the two Base/Feature field pages

@vercel Vercel
Copy link

vercel bot commented Dec 6, 2023 •
edited
Loading

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
eufemia ✅ Ready (Inspect) Visit Preview 💬 Add feedback Dec 8, 2023 11:36am

@henit henit requested a review from tujoworker December 6, 2023 10:40
@codesandbox-ci CodeSandbox CI
Copy link

codesandbox-ci bot commented Dec 6, 2023 •
edited
Loading

This pull request is automatically built and testable in CodeSandbox.

To see build info of the built libraries, click here or the icon next to each commit SHA.

Latest deployment of this branch, based on commit 9a01bcf:

Sandbox Source
eufemia-starter Configuration

@tujoworker tujoworker requested a review from langz December 7, 2023 11:45
@tujoworker
Copy link
Member

We should check if there are any affected/existing links/urls we need to change.

@langz can you check that?

@langz
Copy link
Contributor

langz commented Dec 7, 2023 •
edited
Loading

It seems to be quite a few broken links.
When checking out this branch, I find several references to the following docs/links, which I don't believe exists anymore:

  • /uilib/extensions/forms/create-component/Field
  • /uilib/extensions/forms/create-component/Value
  • /uilib/extensions/forms/create-component/Value/*:
    • /ulib/extensions/forms/create-component/Value/Boolean
    • /ulib/extensions/forms/create-component/Value/Number
    • /ulib/extensions/forms/create-component/Value/Option
    • /ulib/extensions/forms/create-component/Value/String
    • /ulib/extensions/forms/create-component/Value/BankAccountNumber
    • /ulib/extensions/forms/create-component/Value/NationalIdentityNumber
    • /ulib/extensions/forms/create-component/Value/Currency
    • /ulib/extensions/forms/create-component/Value/Date
    • /ulib/extensions/forms/create-component/Value/PhoneNumber
    • /ulib/extensions/forms/create-component/Value/Email

This can be seen when clicking Field or Value links in the following page(but I believe the same issue exists multiple places): https://eufemia-git-chore-forms-extended-features-docs-eufemia.vercel.app/uilib/extensions/forms/create-component/FieldBlock/

@henit henit force-pushed the chore/forms-extended-features-docs branch from 8f28e23 to e062926 Compare December 7, 2023 13:32
langz
langz approved these changes Dec 7, 2023
View reviewed changes
Copy link
Contributor

@langz langz left a comment •
edited
Loading

Choose a reason for hiding this comment

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

Thanks for the great effort 👏
I added a comment with a few broken links that I could find, seems like they are already fixed 🙇

I can take a quick round of testing after the latest changes is ready in the preview, to see if I can find anything related to the latest changes/commits.

@henit
Copy link
Contributor Author

henit commented Dec 8, 2023 •
edited
Loading

I can take a quick round of testing after the latest changes is ready in the preview, to see if I can find anything related to the latest changes/commits.

@langz Have tou re-checked? Don't want to merge before you are finished.

@langz
Copy link
Contributor

langz commented Dec 8, 2023 •
edited
Loading

I can take a quick round of testing after the latest changes is ready in the preview, to see if I can find anything related to the latest changes/commits.

@langz Have tou re-checked? Don't want to merge before you are finished.

I can re-check in about 30min🚀
Will report back🤞

tujoworker
tujoworker approved these changes Dec 8, 2023
View reviewed changes
Copy link
Member

@tujoworker tujoworker left a comment

Choose a reason for hiding this comment

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

Looks good. Thank you 👍

@tujoworker
Copy link
Member

tujoworker commented Dec 8, 2023 •
edited
Loading

But maybe we should improve the "about fields" titles to something like this?

Screenshot 2023-12-08 at 09 51 49

vs

Screenshot 2023-12-08 at 09 52 31

@langz
Copy link
Contributor

langz commented Dec 8, 2023

But maybe we should improve the "about fields" titles to something like this?

Screenshot 2023-12-08 at 09 51 49 vs Screenshot 2023-12-08 at 09 52 31

Great idea, I can make this improvement, either as part of this PR or as part of a new PR

@langz langz self-requested a review December 8, 2023 09:24
langz
langz approved these changes Dec 8, 2023
View reviewed changes
Copy link
Contributor

@langz langz left a comment •
edited
Loading

Choose a reason for hiding this comment

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

Thanks again :)

The links works way better this time around, only broken link I found when re-testing was comment

I'll add a fix for the comment and improve upon the suggestion #2978 (comment), and merge this 🙇

@langz
Copy link
Contributor

langz commented Dec 8, 2023 •
edited
Loading

I've now added a commit to improve upon the following suggestion.

Does it look good @tujoworker?

If we are happy with this, I suggest merging this PR 🚀

Here's a link to the preview

And here's a screenshot:
Screenshot 2023-12-08 at 12 32 14

@tujoworker
Copy link
Member

@langz yes, you can merge them ✅

@langz langz merged commit 6fb8d4a into main Dec 8, 2023
10 checks passed
@langz langz deleted the chore/forms-extended-features-docs branch December 8, 2023 13:05
@tujoworker
Copy link
Member

🎉 This PR is included in version 10.15.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@langz langz langz approved these changes

@tujoworker tujoworker tujoworker approved these changes

Assignees
No one assigned
Labels
released
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@henit @tujoworker @langz