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.

Sign up for GitHub

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

Jump to bottom

docs: use mermaid for class diagram #1547

Merged
merged 4 commits into from
Oct 5, 2023
Merged

docs: use mermaid for class diagram #1547

merged 4 commits into from
Oct 5, 2023

Conversation

loan-mgt
Copy link
Contributor

@loan-mgt loan-mgt commented Oct 4, 2023

Description
Corrected sentence:

  • Update documentation internal-model class diagram from PNG to Mermaid allowing for easier updates. Preview result here

Related issue(s)
Resolves #1182

@netlify
Copy link

netlify bot commented Oct 4, 2023 •
edited
Loading

✅ Deploy Preview for modelina ready!

Name Link
🔨 Latest commit 45b8dc1
🔍 Latest deploy log https://app.netlify.com/sites/modelina/deploys/651e7ad90f5b5f00083ecba0
😎 Deploy Preview https://deploy-preview-1547--modelina.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@coveralls
Copy link

coveralls commented Oct 4, 2023 •
edited
Loading

Pull Request Test Coverage Report for Build 6416880153

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 92.231%
Totals Coverage Status
Change from base Build 6411893086: 0.0%
Covered Lines: 5276
Relevant Lines: 5578
💛 - Coveralls

jonaslagoni
jonaslagoni requested changes Oct 4, 2023
View reviewed changes
Copy link
Member

@jonaslagoni jonaslagoni left a comment

Choose a reason for hiding this comment

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

Nice @Qypol342, this is really needed 👍

docs/internal-model.md Outdated

class ObjectModel{
<<class>>
String, ObjectPropertyModel properties
Copy link
Member

Choose a reason for hiding this comment

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

Looks like there are a few of the properties that are missing their types. In the old image, it's a dictionary with string key and ObjectPropertyModel value 🙂

There are a few places this applies 🙂

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@jonaslagoni There you go! I've fixed it up. 🙃

jonaslagoni
jonaslagoni reviewed Oct 4, 2023
View reviewed changes
Copy link
Member

@jonaslagoni jonaslagoni left a comment

Choose a reason for hiding this comment

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

image

The property --> MetaModel is that correct? or is it being displayed incorrectly? 🤔

@loan-mgt
Copy link
Contributor Author

loan-mgt commented Oct 4, 2023

image

The property --> MetaModel is that correct? or is it being displayed incorrectly? 🤔

I've just followed the original doc:
image

property --> MetaModel the way it is written is the mermaid standard to signify an association without the arrow going all over the schema

I can make it look the old good way by not specifying which attribute the association comes from.

jonaslagoni
jonaslagoni approved these changes Oct 5, 2023
View reviewed changes
Copy link
Member

@jonaslagoni jonaslagoni left a comment

Choose a reason for hiding this comment

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

Alright, let's keep it 👍

@jonaslagoni jonaslagoni changed the title feat: doc png graph -> mermaid docs: use mermaid for class diagram Oct 5, 2023
@sonarqubecloud
Copy link

sonarqubecloud bot commented Oct 5, 2023

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
No Duplication information No Duplication information

@jonaslagoni
Copy link
Member

/rtm

@jonaslagoni jonaslagoni merged commit fab7037 into asyncapi:master Oct 5, 2023
19 checks passed
@jonaslagoni
Copy link
Member

@all-contributors please add @Qypol342 for docs

@allcontributors allcontributors bot mentioned this pull request Oct 5, 2023
Merged
@allcontributors
Copy link
Contributor

@jonaslagoni

I've put up a pull request to add @Qypol342! 🎉

@kennethaasan
Copy link
Collaborator

Really great stuff @Qypol342!

@asyncapi-bot
Copy link
Contributor

🎉 This PR is included in version 1.9.1 🎉

The release is available on:

Your semantic-release bot 📦🚀

@asyncapi-bot
Copy link
Contributor

🎉 This PR is included in version 2.0.0-next.25 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jonaslagoni jonaslagoni jonaslagoni approved these changes

Assignees
No one assigned
Labels
ready-to-merge released on @next released
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

[📑 Docs]: Use code to represent the internal models
5 participants
@loan-mgt @coveralls @jonaslagoni @kennethaasan @asyncapi-bot