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: add description to modelina docs #775

Merged
merged 11 commits into from
Jul 13, 2022
Merged

docs: add description to modelina docs #775

merged 11 commits into from
Jul 13, 2022

Conversation

Dule-martins
Copy link
Contributor

@Dule-martins Dule-martins commented May 17, 2022 •
edited
Loading

Description

I added the information about generating models from AsynAPI, OpenAPl and JSON schemes to the homepage.
As discussed in the comment asyncapi/modelina#605

@netlify
Copy link

netlify bot commented May 17, 2022 •
edited
Loading

✅ Deploy Preview for asyncapi-website ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit 97f5ce4
🔍 Latest deploy log https://app.netlify.com/sites/asyncapi-website/deploys/62ce367fac3b730008c33ea3
😎 Deploy Preview https://deploy-preview-775--asyncapi-website.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 settings.

github-actions[bot]
github-actions bot reviewed May 17, 2022
View reviewed changes
Copy link

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

Welcome to AsyncAPI. Thanks a lot for creating your first pull request. Please check out our contributors guide useful for opening a pull request.
Keep in mind there are also other channels you can use to interact with AsyncAPI community. For more details check out this issue.

@github-actions
Copy link

github-actions bot commented May 17, 2022 •
edited
Loading

⚡️ Lighthouse report for the changes in this PR:

Category Score
🔴 Performance 46
🟢 Accessibility 95
🟠 Best practices 83
🟢 SEO 100
🔴 PWA 30

Lighthouse ran on https://deploy-preview-775--asyncapi-website.netlify.app/

@Dule-martins Dule-martins changed the title Modelina Description docs: Modelina Description May 17, 2022
@Dule-martins Dule-martins changed the title docs: Modelina Description docs: added description to modelina docs May 17, 2022
starlightknown
starlightknown reviewed May 17, 2022
View reviewed changes
Copy link
Contributor

@starlightknown starlightknown left a comment •
edited
Loading

Choose a reason for hiding this comment

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

The description on the page looks fine but in this menu here

image

I think we should display the second sentence, so it won't be confusing
i.e, Modelina is a library for generating data models based on inputs such as AsyncAPI, OpenAPI, or JSON Schema documents

@derberg derberg changed the title docs: added description to modelina docs docs: add description to modelina docs May 18, 2022
@derberg
Copy link
Member

derberg commented May 18, 2022

@Dule-mart I agree with @starlightknown on the menu. If you could update it too, it would be awesome.

Also, please link your PR properly with therelated issue so that once we merge this PR, related issue is closed. Have a look at https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue for more details

@Dule-martins
Copy link
Contributor Author

Dule-martins commented May 19, 2022 via email

magicmatatjahu
magicmatatjahu approved these changes May 20, 2022
View reviewed changes
Copy link
Member

@magicmatatjahu magicmatatjahu left a comment

Choose a reason for hiding this comment

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

@alequetzalli Could you take a look on it?

@Dule-martins
Copy link
Contributor Author

Added the description to the menu

starlightknown
starlightknown approved these changes May 21, 2022
View reviewed changes
Copy link
Contributor

@starlightknown starlightknown left a comment

Choose a reason for hiding this comment

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

LGTM, thanks for adding it :)

@magicmatatjahu
Copy link
Member

@alequetzalli ping ping :)

@derberg
Copy link
Member

derberg commented Jun 23, 2022

@alequetzalli wanna have a look?

@derberg
Copy link
Member

derberg commented Jul 13, 2022

/rtm

@asyncapi-bot asyncapi-bot merged commit 1073b76 into asyncapi:master Jul 13, 2022
@derberg
Copy link
Member

derberg commented Jul 13, 2022

@all-contributors please add @Dule-mart for docs

@allcontributors allcontributors bot mentioned this pull request Jul 13, 2022
Merged
@allcontributors
Copy link
Contributor

@derberg

I've put up a pull request to add @Dule-mart! 🎉

@jonaslagoni jonaslagoni mentioned this pull request Jul 28, 2022
Closed
1 task
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@github-actions github-actions[bot] github-actions[bot] left review comments

@quetzalliwrites quetzalliwrites quetzalliwrites approved these changes

@magicmatatjahu magicmatatjahu magicmatatjahu approved these changes

@starlightknown starlightknown starlightknown approved these changes

@fmvilas fmvilas Awaiting requested review from fmvilas

@derberg derberg Awaiting requested review from derberg derberg is a code owner

@asyncapi-bot-eve asyncapi-bot-eve Awaiting requested review from asyncapi-bot-eve asyncapi-bot-eve is a code owner

Assignees
No one assigned
Labels
ready-to-merge
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
6 participants
@Dule-martins @derberg @magicmatatjahu @quetzalliwrites @starlightknown @asyncapi-bot