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

refactor: update maintainers list, introduce isTscMember key, and remove tsc_member.json file #1722

Merged
merged 30 commits into from Jul 5, 2023

Conversation

14Richa
Copy link
Contributor

@14Richa 14Richa commented May 29, 2023

Description
This PR updates the maintainers list by introducing a new file called Maintainers.json and removing the old tsc_member.json file. The new Maintainers.json file contains the same data as the previous tsc_member.json, but with the addition of a new boolean key called isTscMember. This key indicates whether a maintainer is a member of the TSC or not.

To reflect this change on the website, the Maintainers.json file is called in a React component and filtered so that only maintainers whose isTscMember value is true are displayed.

@netlify
Copy link

netlify bot commented May 29, 2023

Deploy Preview for asyncapi-website ready!

Name Link
🔨 Latest commit d3549e6
🔍 Latest deploy log https://app.netlify.com/sites/asyncapi-website/deploys/64a55f25368e660008e0a458
😎 Deploy Preview https://deploy-preview-1722--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 configuration.

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.

@14Richa 14Richa changed the title Changed tsc_members.json file to tsc_members.yaml file refactor: changed tsc_members.json file to tsc_members.yaml file May 29, 2023
Copy link
Member

@derberg derberg left a comment

Choose a reason for hiding this comment

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

I think this PR can come hand in hand with changes from community repo

so remove tsc members doc, and operate already on maintainers file, just in UI code you will need to make sure that from maintainers.yml you read only the ones that are marked as maintainers

next.config.js Outdated Show resolved Hide resolved
@14Richa 14Richa marked this pull request as ready for review June 8, 2023 08:15
@14Richa
Copy link
Contributor Author

14Richa commented Jun 9, 2023

I think this PR can come hand in hand with changes from community repo

so remove tsc members doc, and operate already on maintainers file, just in UI code you will need to make sure that from maintainers.yml you read only the ones that are marked as maintainers

I would like to clarify a few points regarding the comment :

  1. Please provide more information about the changes you are referring to from the community repo.
  2. The maintainers.yml file could be modified to only include maintainers' information or a new key such as "IsMaintainer" could be added.
  3. How should the decision be made regarding who will be the maintainer of the repository?

@github-actions
Copy link

github-actions bot commented Jun 9, 2023

⚡️ Lighthouse report for the changes in this PR:

Category Score
🔴 Performance 42
🟢 Accessibility 98
🟢 Best practices 100
🟢 SEO 100
🔴 PWA 30

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

package.json Outdated Show resolved Hide resolved
@14Richa 14Richa changed the title refactor: changed tsc_members.json file to tsc_members.yaml file refactor: convert tsc_member.json file to maintainers.yaml and use in React component Jun 12, 2023
@derberg
Copy link
Member

derberg commented Jun 20, 2023

@14Richa yes, we need a flag that determines if maintainer is a TSC member. Human will add such information to the Maintainers.yml file.

Original Maintainers.yml will be in community repo, while here in this repo we just keep a copy that is maintained by the bot, just like with tsc info -> https://github.com/asyncapi/website/pull/1705/files. But for the sake of this PR, you can of course maintain it manually.

How someone becomes a maintainer in any existing asyncapi repo? -> https://github.com/asyncapi/community/blob/master/Become-maintainer-in-existing-project.md

@14Richa 14Richa changed the title refactor: convert tsc_member.json file to maintainers.yaml and use in React component refactor: update maintainers list, introduce isTscMember key, and remove tsc_member.json file Jun 27, 2023
Copy link
Member

@derberg derberg left a comment

Choose a reason for hiding this comment

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

just one small stuff that you could not know about

plan should be that we first merge asyncapi/community#720 and then this PR

package.json Outdated Show resolved Hide resolved
Co-authored-by: Lukasz Gornicki <lpgornicki@gmail.com>
derberg
derberg previously approved these changes Jul 5, 2023
Copy link
Member

@derberg derberg left a comment

Choose a reason for hiding this comment

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

All good, we just need to wait for asyncapi/community#720 before we merge this one

Copy link
Member

@KhudaDad414 KhudaDad414 left a comment

Choose a reason for hiding this comment

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

LGTM

@derberg
Copy link
Member

derberg commented Jul 5, 2023

@14Richa there is a merge conflict that you need to address

since you remove tsc member json, but it was just updated in master, you need to confirm removal basically

@derberg
Copy link
Member

derberg commented Jul 5, 2023

/rtm

@derberg
Copy link
Member

derberg commented Jul 5, 2023

/rtm

@asyncapi-bot asyncapi-bot merged commit ff50baa into asyncapi:master Jul 5, 2023
15 checks passed
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.

None yet

5 participants