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

Enhance Jargon.sh UML Diagrams to Indicate Required Fields #215

Open
3 of 4 tasks
ashleythedeveloper opened this issue Nov 17, 2024 · 2 comments
Open
3 of 4 tasks
Assignees
Labels

Comments

@ashleythedeveloper
Copy link
Contributor

ashleythedeveloper commented Nov 17, 2024

Impacted sections

Issue Description

As a Business Analyst,
I want the UNTP UML diagrams in Jargon.sh to clearly indicate which fields are required for each Object type,
So that I can more easily perform data mapping and credential building without needing to reference technical schema files.

Acceptance Criteria:

  • Review the current UNTP UML diagram generation process in Jargon.sh
  • Develop a visual indicator system for required fields in UML diagrams (e.g., asterisk, bold text, or other clear visual marker)
  • Update UML diagram generation to include required field indicators based on data model specifications
  • Apply updates to all existing UML diagrams in UNTP core data models

I don't feel this is the right place for this ticket, but I need to store it somewhere to track this issue/visibility.

@ashleythedeveloper
Copy link
Contributor Author

I've reached out to Alastair from Jargon to begin the conversation.

@colugo
Copy link

colugo commented Nov 17, 2024

Hi @ashleythedeveloper I made this change in Jargon a little while ago, and it's now live. Next time those domains are changed and released, jargon's webhook will provide new diagrams to the github actions script.

image

Here's a link to one of the domains that shows what this looks like:

https://jargon.sh/user/unece/DigitalProductPassport/v/working/artefacts/diagram/render.svg?light=true

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants