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

Implementing the AsyncAPI Financial Summary Page #1723

Closed
Mayaleeeee opened this issue May 29, 2023 · 19 comments · Fixed by #2038
Closed

Implementing the AsyncAPI Financial Summary Page #1723

Mayaleeeee opened this issue May 29, 2023 · 19 comments · Fixed by #2038

Comments

@Mayaleeeee
Copy link
Member

Mayaleeeee commented May 29, 2023

Reason/Context:

  • Why do we need this improvement?
    The addition of the AsyncAPI Financial Summary page aims to provide transparency and clarity regarding the organization's financial activities. It serves as a platform to showcase how donations are accepted, different sponsorship options, and how the generated funds are utilized.

  • How will this change help?
    This change will enable the AsyncAPI community to understand how the organization manages its finances. It provides a comprehensive overview of expenses, offering a breakdown of where the funds are allocated. By providing this financial transparency, contributors and community members can be confident in how their donations and sponsorships are utilized.

  • What is the motivation?
    The motivation behind implementing the AsyncAPI Financial Summary page is to enhance transparency and accountability within the organization. By showcasing how the funds are used, AsyncAPI aims to build trust and demonstrate its commitment to responsible financial management.

Description:

  • What changes have to be introduced?
    The proposed change involves implementing the already designed AsyncAPI Financial Summary page. This page will display detailed information about donation acceptance methods, sponsorship opportunities, and a breakdown of expenses incurred by AsyncAPI.

  • Will this be a breaking change?
    No, this implementation does not involve any fundamental modifications to the existing website. This new feature can be seamlessly integrated without disrupting the current functionality.

  • How could contributors implement it?
    Contributors can actively participate in implementing the designed AsyncAPI Financial Summary page by utilizing the already prepared design assets. This would involve translating the design elements into functional code, ensuring the page accurately represents the intended layout and content.

@derberg @AceTheCreator @thulieblack

https://www.figma.com/file/MMOuTQ7QaPu6BL2TJrhjw5/AsyncAPI-Financial-Summary?type=design&node-id=0%3A1&t=r1htfrrAvNEK2HMY-1

@github-actions
Copy link

Welcome to AsyncAPI. Thanks a lot for reporting your first issue. Please check out our contributors guide and the instructions about a basic recommended setup 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.

@Shurtu-gal
Copy link
Contributor

@Mayaleeeee Can I work upon this?

@Mayaleeeee
Copy link
Member Author

@Mayaleeeee Can I work upon this?

You can, but let's hear from @derberg and others first.

@derberg derberg transferred this issue from asyncapi/community May 29, 2023
@derberg
Copy link
Member

derberg commented May 29, 2023

@Shurtu-gal before opening PR please specify your implementation plans

some more context about the new view -> asyncapi/community#672

@Shurtu-gal
Copy link
Contributor

@derberg What I would do is :-

  • Add data in JSON which can be parsed and shown on website. This would cover most of the data.
  • For the visualization we can use some package such as Nivo, ChartJS etc.

@SumantxD
Copy link
Contributor

  • D3 js can also be used for data visualization, it offers more functionality and flexibility
    @Shurtu-gal @derberg

@Shurtu-gal
Copy link
Contributor

@derberg if you like the proposed method can I start working upon this.

@derberg
Copy link
Member

derberg commented Jun 27, 2023

sorry, was out on holidays, can we do markdown with front matter instead of json?

@Shurtu-gal
Copy link
Contributor

But markdown won't have the design right? 🤔

@SumantxD
Copy link
Contributor

But markdown won't have the design right? thinking

we can use libraries like gray matter to extract the content and display it in react code, I would still prefer JSON though. 🙂

@Shurtu-gal
Copy link
Contributor

But markdown won't have the design right? thinking

we can use libraries like gray matter to extract the content and display it in react code, I would still prefer JSON though. 🙂

Is there any specific reason markdown must be used?

@thulieblack
Copy link
Member

We use markdown throughout the website, so it makes sense in terms of consistency and maintenance.

Copy link
Member

derberg commented Jun 27, 2023

@Shurtu-gal something else than JSON 🙏
you have 2 options

  • Markdown with front matter that will allow you to have structured data for the UI
  • YAML directly, as we have some stuff on the website that come from YAML, so we could agree for the same here as in your case, you need a well structured info to extract it easily

JSON is not for humans 😃 and this content will be maintained by humans

@Shurtu-gal
Copy link
Contributor

Alright, I will do it with markdown, then.

Copy link
Member

derberg commented Jun 28, 2023

and if that is not the best, remember you can fallback to YAML

@Shurtu-gal
Copy link
Contributor

Okay

@derberg
Copy link
Member

derberg commented Aug 1, 2023

@Shurtu-gal hey, do you plan to continue with this one?

@Shurtu-gal
Copy link
Contributor

@derberg Actually, I am a little swamped with Mentorship and things in Studio, so unfortunately I won't be able to work on this.

Sorry for not informing before.

Copy link
Member

derberg commented Aug 2, 2023

@Shurtu-gal good luck with mentorship, and thanks for the info

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

Successfully merging a pull request may close this issue.

5 participants