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

SOW: HYRAX - Completion of AllinsonFlex #1

Open
16 of 36 tasks
jillpe opened this issue Jun 3, 2024 · 1 comment
Open
16 of 36 tasks

SOW: HYRAX - Completion of AllinsonFlex #1

jillpe opened this issue Jun 3, 2024 · 1 comment
Labels
allinson flex amigos blocked other work must be completed first hyrax prime

Comments

@jillpe
Copy link

jillpe commented Jun 3, 2024

SoftServ will complete AllinsonFlex (https://github.com/samvera-labs/allinson_flex) work that includes
the development of a UI for administering flexible metadata in the admin dashboard. This work will
include the following steps:

  1. Create a DatabaseSchemaLoader that mimics the SimpleSchemaLoader but is called on object
    instantiation
  2. Add versions to database schemas and track schema versions in work types
  3. Add interface to admin area to download and upload schema
  4. Port existing AllinsonFlex work versioning UI over to new code
  5. Expand DatabaseSchemaLoader to handle M3 (Machine-readable Metadata Modeling) spec
  6. Port AllinsonFlex react UI for existing schemas
    In response to feedback from Hyku community users, this work will include:
    ● A UI for editing and creating metadata
    ● Optional ability to make updates with upload of Yaml file will be retained
    ● Ability to create and update new work types and metadata profiles
    ● Ability to create fields or edit/update field names
    ● Ability to determine which fields are required
    ● Contexts, a preset of metadata fields related to a specific repository or source, attached to an
    admin set, as implemented by Indiana University
    ● M3 (Machine-readable Metadata Modeling) metadata specification

Acceptance Criteria

  • A UI for editing and creating metadata is available
  • Optional ability to make updates with upload of Yaml file will be retained
  • Ability to create and update new work types and metadata profiles
  • Ability to create fields or edit/update field names
  • Ability to determine which fields are required
  • Contexts, a preset of metadata fields related to a specific repository or source, attached to an admin set, as implemented by Indiana University
  • M3 (Machine-readable Metadata Modeling) metadata specification

Testing Instructions

  1. Initital
    Visit the metadata profiles tab. v1.0 matches the basic schema defined by Hyrax/Hyku.
    Manually create a single work from the UI (from profile v1.0)

  2. Customizations
    Visit the metadata profiles tab again. Download this profile as a start, and add custom properties.
    Upload the custom profile
    Create a new work (from profile v2.0)
    The form should render the additional properties, as defined in the uploaded profile.
    After saving, properties should render on the show page (if defined to do so)
    Note: We are aware there's a bug when removing properties

  1. EDITING previously created works
    If you Edit a work that was created on a previous profile, its form will no longer reflect the metadata of the profile it was created on. The form and show page should reflect the metadata defined on the latest uploaded profile. If you save the work, it will be saved using the schema of the latest uploaded profile.
    The user will see this noted in the form via the profile badges, like
image

TASKS

BUGS

Nice to Haves

@ShanaLMoore
Copy link

client review is blocked by #54

@ShanaLMoore ShanaLMoore moved this to Client Verification in Amigos Aug 30, 2024
@ShanaLMoore ShanaLMoore removed the status in Amigos Aug 30, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
allinson flex amigos blocked other work must be completed first hyrax prime
Projects
Status: No status
Development

No branches or pull requests

2 participants