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

EDITOR - Organize fields into pages and sections #938

Merged
merged 7 commits into from
Jul 23, 2024

Conversation

rcaplier
Copy link
Collaborator

@rcaplier rcaplier commented Jul 10, 2024

Description

This PR organize editor fields into pages and sections.

Screenshots

image
image

Quality Assurance Checklist

  • Commit history is devoid of any merge commits and readable to facilitate reviews
  • If new logic ⚙️ is introduced: unit tests were added
  • If new user stories 🤏 are introduced: E2E tests were added
  • If new UI components 🕹️ are introduced: corresponding stories in Storybook were created
  • If breaking changes 🪚 are introduced: add the breaking change label
  • If bugs 🐞 are fixed: add the backport <release branch> label
  • The documentation website 📚 has received the love it deserves

This work is sponsored by Metadata-editor crowdfunding.

@rcaplier rcaplier self-assigned this Jul 10, 2024
@rcaplier rcaplier force-pushed the me-organize-fields-into-pages-and-sections branch 2 times, most recently from 9553beb to 41b54c0 Compare July 10, 2024 15:09
Copy link
Contributor

github-actions bot commented Jul 10, 2024

Affected libs: common-fixtures, api-metadata-converter, api-repository, feature-catalog, feature-record, feature-router, feature-search, feature-map, feature-dataviz, feature-editor, feature-auth, ui-search, ui-elements, feature-notifications, ui-catalog, util-shared, ui-widgets, ui-inputs, ui-layout, ui-map,
Affected apps: metadata-editor, metadata-converter, datahub, demo, webcomponents, search, map-viewer, datafeeder,

  • 🚀 Build and deploy storybook and demo on GitHub Pages
  • 📦 Build and push affected docker images

Copy link
Contributor

github-actions bot commented Jul 10, 2024

📷 Screenshots are here!

Copy link
Collaborator

@LHBruneton-C2C LHBruneton-C2C left a comment

Choose a reason for hiding this comment

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

Thanks for this first version!
The code is looking real good, didn't take the time to test.
A few remarks:

  • datahub in commit messages => metadata-editor
  • I like the new editor configuration, although I find it weird that each record should come with the app config. I don't know how to change it though. Maybe having a dedicated EditorConfig service appart from the fields.

And also, I was told not to put the Jira ticket tag in the PR, as this is public work.

@rcaplier rcaplier changed the title EDITOR [GSGNEDIT-87] - Organize fields into pages and sections EDITOR - Organize fields into pages and sections Jul 15, 2024
@rcaplier rcaplier force-pushed the me-organize-fields-into-pages-and-sections branch 2 times, most recently from 86e584d to f100ab3 Compare July 16, 2024 05:18
@rcaplier rcaplier marked this pull request as ready for review July 16, 2024 12:16
@rcaplier rcaplier force-pushed the me-organize-fields-into-pages-and-sections branch 2 times, most recently from b0565ed to 6357e36 Compare July 16, 2024 12:50
@coveralls
Copy link

Coverage Status

coverage: 81.552% (-2.0%) from 83.533%
when pulling 6357e36 on me-organize-fields-into-pages-and-sections
into e77c0f8 on main.

Copy link
Collaborator

@jahow jahow left a comment

Choose a reason for hiding this comment

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

This is a first review, I'll take more time to look into the rest.

First, thank you for the extensive work! I like the general approach and I agree that adding a pages > sections > fields hierarchical structure in the config is the right way to go.

As for the editor state, what do you think about storing the active page in the state, then instead of having a selectRecordFields selector, provide a selectEditorSections selector instead? Then the record-form component would get a list of sections according to the current page, and show them including the fields they contain.

That would also mean that the Breadcrumbs (or really page selector) component would be connected to the editor state directly.

apps/metadata-editor/tsconfig.json Outdated Show resolved Hide resolved
libs/feature/editor/src/index.ts Outdated Show resolved Hide resolved
assets-common/css/default-fonts.css Outdated Show resolved Hide resolved
tailwind.base.config.js Outdated Show resolved Hide resolved
libs/feature/editor/src/lib/models/editor-config.model.ts Outdated Show resolved Hide resolved
libs/feature/editor/src/lib/models/editor-config.model.ts Outdated Show resolved Hide resolved
apps/metadata-editor/src/app/edit/edit-page.component.html Outdated Show resolved Hide resolved
libs/feature/editor/src/lib/models/editor-config.model.ts Outdated Show resolved Hide resolved
@rcaplier rcaplier force-pushed the me-organize-fields-into-pages-and-sections branch 3 times, most recently from 3ab0175 to 5995a95 Compare July 23, 2024 08:02
@rcaplier rcaplier force-pushed the me-organize-fields-into-pages-and-sections branch 2 times, most recently from 703b5e7 to c1840db Compare July 23, 2024 08:21
@rcaplier rcaplier force-pushed the me-organize-fields-into-pages-and-sections branch from c1840db to 7ae1be7 Compare July 23, 2024 08:34
Copy link
Collaborator

@jahow jahow 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! I've made a few comments for cleaning up things, but apart from that it's good to go.

@rcaplier rcaplier force-pushed the me-organize-fields-into-pages-and-sections branch from 59284de to f2ae2cf Compare July 23, 2024 09:23
@rcaplier rcaplier merged commit db93b4c into main Jul 23, 2024
9 checks passed
@rcaplier rcaplier deleted the me-organize-fields-into-pages-and-sections branch July 23, 2024 09:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants