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

chore: add more categories for tools and support repo description #1143

Merged
merged 4 commits into from
Dec 7, 2022

Conversation

derberg
Copy link
Member

@derberg derberg commented Dec 6, 2022

  • I added .asyncapi-tools file to a few more repos and some categories were missing
  • made description optional as we should read GitHub repo description first
  • made links optional as might be there are no links to provide for the project

@netlify
Copy link

netlify bot commented Dec 6, 2022

Deploy Preview for asyncapi-website ready!

Name Link
🔨 Latest commit 29b6315
🔍 Latest deploy log https://app.netlify.com/sites/asyncapi-website/deploys/6390aa2d281f910009b12adc
😎 Deploy Preview https://deploy-preview-1143--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
Copy link

github-actions bot commented Dec 6, 2022

⚡️ Lighthouse report for the changes in this PR:

Category Score
🟠 Performance 53
🟠 Accessibility 88
🟠 Best practices 83
🟢 SEO 100
🔴 PWA 30

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

@@ -78,10 +79,10 @@ async function convertTools(data) {
}
});
} else {
console.error('Script is not failing, it is just dropping errors for further investigation');
Copy link
Member Author

Choose a reason for hiding this comment

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

moved it up as when I was testing it locally, it was strange to see this at the end of logs, not intuitive.

@derberg
Copy link
Member Author

derberg commented Dec 6, 2022

@akshatnema ok, I added few more tools files and this is why I created this PR.
There is one tool file not yet merged. I'm not planning to add more, but you can :)

let resultantObject = {
title: toolFile.title,
description: toolFile.description,
description: repoDescription || toolFile.description,
Copy link
Member

Choose a reason for hiding this comment

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

My query is what if there are certain repos whose descriptions are not precise enough to show them to readers? There can be the case that the owner of the tool wants to make a custom description for its tool to show up in the dashboard. Then this will create problems.

Copy link
Member

Choose a reason for hiding this comment

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

What problems? If someone will want to precise description will have to write description in the config file. I don't see any problems 😅

Copy link
Member

Choose a reason for hiding this comment

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

Even if someone writes the description, it won't be considered with this implementation as it will only take the description mentioned in the GitHub repository.

Copy link
Member

Choose a reason for hiding this comment

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

Ahh yes, It should be:

toolFile.description || repoDescription,

Copy link
Member Author

Choose a reason for hiding this comment

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

good catch!!!

@derberg
Copy link
Member Author

derberg commented Dec 7, 2022

fixed, and also updated generated files, the last PR I did was updated, so I already updated generated json files

@derberg derberg requested a review from akshatnema December 7, 2022 14:59
Copy link
Member Author

derberg commented Dec 7, 2022

@akshatnema I see @magicmatatjahu approved but I will not merge without your approval 😏

@akshatnema
Copy link
Member

@akshatnema I see @magicmatatjahu approved but I will not merge without your approval 😏

Sorry, I was taking my dinner at that time. Will approve now 😄

@derberg
Copy link
Member Author

derberg commented Dec 7, 2022

/rtm

@asyncapi-bot asyncapi-bot merged commit 7cbb2d8 into asyncapi:master Dec 7, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants