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

Images in Ubiquitous Language definition description #1071

Closed
Jessewb786 opened this issue Jan 6, 2025 · 3 comments
Closed

Images in Ubiquitous Language definition description #1071

Jessewb786 opened this issue Jan 6, 2025 · 3 comments

Comments

@Jessewb786
Copy link

Use Case

My use case is something as follows.
In confluence we have definitions that includes images in the example column of the definition.

These images are highly appreciated as they allow people to also see an example of an item that fits that definition.

Proposed Solution

We could either extend the definition to include an example image. It seems perhaps the most straightforward way of providing the feature.

Alternatively, the description section render markdown.

Either of these would suit my use case. All the best and thanks for the fast response and integration of feedback.

Implementation Notes

No response

Community Notes

  • Please vote by adding a 👍 reaction to the issue to help us prioritize.
  • If you are interested to work on this issue, please leave a comment.
  • If this issue is labeled needs-discussion, it means the spec has not been finalized yet. Please reach out in the EventCatalog Discord.
@boyney123
Copy link
Collaborator

Hey!

Good idea, I like the idea of Alternatively, the description section render markdown. then we can do anything we want really. Did you want to try make a PR? No problem if not we can pick it up

@boyney123
Copy link
Collaborator

Should be added in 2.19.0, we now have pages for each item in your dictionary, if you upgrade then try it.

Your description now supports markdown and will render on the page.

@Jessewb786
Copy link
Author

@boyney123 Thanks! This is much appreciated and more intuitive now with 2.19.1.
Regarding images in the description. Do you happen to know what is the best place to store local images?

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

No branches or pull requests

2 participants