elixir-cloud-aai / cloud-components

Reusable components for the ELIXIR Cloud
https://cloud-components.2.rahtiapp.fi/
Apache License 2.0
8 stars 14 forks source link

feat: created basic section and their forms #355

Closed sivangbagri closed 1 month ago

sivangbagri commented 3 months ago

Description

Fixes #(issue)

Checklist

Comments

Summary by Sourcery

Add a new 'ECCCLientRoCrateAbout' component with tabbed forms for managing metadata sections, and provide demo HTML files for component demonstration.

New Features:

Enhancements:

Documentation:

changeset-bot[bot] commented 3 months ago

⚠️ No Changeset found

Latest commit: d39e6f1b779aa533a773fa38257426a86374191e

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

vercel[bot] commented 3 months ago

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

Name Status Preview Comments Updated (UTC)
elixir-cloud-components ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 12, 2024 9:22pm
sourcery-ai[bot] commented 3 months ago

Reviewer's Guide by Sourcery

This pull request implements a new feature for creating basic sections and their forms in the ecc-client-elixir-ro-crate package. The changes introduce a new LitElement-based component called ECCCLientRoCrateAbout, which creates a tabbed interface for displaying and editing information about RO-Crate metadata. The implementation uses the @elixir-cloud/design library for form components and defines several form fields for different sections of the RO-Crate metadata.

File-Level Changes

Files Changes
packages/ecc-client-elixir-ro-crate/src/components/about/about.ts Created a new LitElement-based component ECCCLientRoCrateAbout with a tabbed interface for RO-Crate metadata editing
packages/ecc-client-elixir-ro-crate/src/components/about/about.ts Defined form fields for 'About', 'Related People', and 'Structure' sections of RO-Crate metadata
packages/ecc-client-elixir-ro-crate/src/components/about/about.ts Implemented tab switching functionality in the ECCCLientRoCrateAbout component
packages/ecc-client-elixir-ro-crate/demo/about/index.html Added a demo HTML file for the new ECCCLientRoCrateAbout component
packages/ecc-client-elixir-ro-crate/src/components/about/index.ts Created an index file for exporting the ECCCLientRoCrateAbout component and defining it as a custom element
packages/ecc-client-elixir-ro-crate/demo/index.html Added a main demo page with a link to the 'About' component demo

Tips - Trigger a new Sourcery review by commenting `@sourcery-ai review` on the pull request. - Continue your discussion with Sourcery by replying directly to review comments. - You can change your review settings at any time by accessing your [dashboard](https://app.sourcery.ai): - Enable or disable the Sourcery-generated pull request summary or reviewer's guide; - Change the review language; - You can always [contact us](mailto:support@sourcery.ai) if you have any questions or feedback.
sivangbagri commented 3 months ago

@salihu @anuragxxd Kindly review. Ignore naming issues , I will fix it

SalihuDickson commented 3 months ago

hi @sivangbagri, I'm having a bit of trouble reviewing your code, can you please create an issue that goes into detail about the goals of this project and how you are going about achieving said goals. Also include important links like the schema for the version of ro-crate you're working with, and links to any referenced projects or profiles. If there is one already please link it in the PR description.

sivangbagri commented 3 months ago

@SalihuDickson Hii , check this out : https://github.com/elixir-cloud-aai/cloud-components/issues/356 . If anything else is needed please let me know

sivangbagri commented 1 month ago

@anuragxxd new commit has required changes along with improved form structure of about and hasPart sections.

SalihuDickson commented 1 month ago

The fields you've added for the Author, Publisher and Funder fields won't really work, based on the minimum requirements for the Ro-Crates.

The author object is would be an instance of a people entitiy. The Publisher object would be an instance of an organization entity or a people entity The Funder object can also be an Organization or a people entity

perhaps the "Related People, Orgs & Works" page can contain all contextual entities, but we would need a better design to make that clear, as the current structure implies several disjointed entities.

This is a lot at this point, my suggestion would be that you convert this to a draft and create a new PR solely adding fields for the metadata entity, another for the dataset entity and then we can address these other objects and entities in subsequent PRs.

SalihuDickson commented 1 month ago

I was in the process of trying to revert the ro-crate changes and merge the build fixes from earlier but i just realized those have already been implemented on main. I think you can go ahead and close this PR.