Introducing a Dedicated Design Issues Section on the AsyncAPI GitHub Issue Page

[Mayaleeeee]

Reason/Context

I propose the addition of a dedicated Design Issues section on the AsyncAPI Issue page hosted on GitHub. This section serves as a platform for addressing and discussing design-related concerns within the AsyncAPI project. By incorporating this dedicated section, we can efficiently gather and collaborate on design issues, ensuring their visibility and fostering constructive conversations among contributors.

One of the key motivations behind this proposal is to alleviate the confusion when reporting design-related problems. Currently, while creating an issue on the platform, there are options for bugs, documentation reports, and other categories. However, a more straightforward choice for reporting design issues that require attention is needed. This poses challenges for both new and experienced contributors.

Introducing a dedicated design issue section aims to streamline the process, making it easier for all contributors to report design-related concerns. It will provide a clear and accessible option for raising design issues that require resolution. Ultimately, this addition will enhance the overall user experience, promoting effective collaboration and problem-solving in design.

Description

• What changes have to be introduced?
  The proposed change is to include a section specifically dedicated to Design Issues on the AsyncAPI Issue page on GitHub.

• Will this be a breaking change?
  No, this change is not expected to be a breaking change. It aims to enhance the issue page by adding a dedicated section for design-related concerns.

• How could it be implemented/designed?
  The implementation would involve modifying the structure of the AsyncAPI Issue page on GitHub to incorporate a distinct section for Design Issues. This section would allow contributors to raise and discuss design-related matters, providing a platform for collaboration and problem-solving in that specific area.

@thulieblack @derberg @AceTheCreator @fmvilas @akshatnema

[SumantxD]

@Mayaleeeee
If required, I can work on this issue. 😃

[derberg]

I think it makes sense, just please define what content you'd like to have in it, and if you want normal view like with Bug report or form-like as we have with Docs

[Mayaleeeee]

I think it makes sense, just please define what content you'd like to have in it, and if you want normal view like with Bug report or form-like as we have with Docs

Hi @derberg
Is this what you meant for the content? Please check the attached screenshot.

Bug report

Docs

[derberg]

yes, exactly, so do you want just classic text with explanation, or the form-like approach

[Mayaleeeee]

The two look good, but I prefer the form-like as it is more specific and direct.
Is it possible to have a progress tracker for design-related issues as it is on the Dev Docs board as well? Cause one of the motivations behind this suggestion is I encountered a situation where I raised an issue, not knowing someone else had already done the same. I believe having the progress tracker and the board would help avoid duplication of issues.

What do you think?

[derberg]

@Mayaleeeee if you need project board then do it, but I'm not very helpful here as I do not use it. Check with @alequetzalli that does it for docs or @fmvilas that also used it in the past I think

[Mayaleeeee]

@Mayaleeeee if you need project board then do it, but I'm not very helpful here as I do not use it. Check with @alequetzalli that does it for docs or @fmvilas that also used it in the past I think

Thanks @derberg
We already have something like this for design.

[github-actions]

This issue has been automatically marked as stale because it has not had recent activity 😴

It will be closed in 120 days if no further activity occurs. To unstale this issue, add a comment with a detailed explanation.

There can be many reasons why some specific issue has no activity. The most probable cause is lack of time, not lack of interest. AsyncAPI Initiative is a Linux Foundation project not owned by a single for-profit company. It is a community-driven initiative ruled under open governance model.

Let us figure out together how to push this issue forward. Connect with us through one of many communication channels we established here.

Thank you for your patience ❤️

[AnimeshKumar923]

still valid? @Mayaleeeee

[Mayaleeeee]

still valid? @Mayaleeeee

Yeah.

[sambhavgupta0705]

@Mayaleeeee what's the udpdate of this issue?

[Mayaleeeee]

@Mayaleeeee what's the udpdate of this issue?

Thanks for the pinging @sambhavgupta0705

@AnimeshKumar923, you showed interest earlier, and I'm following up to see if you've had a chance to work on it. If not, no worries, just wanted to check in.

[AnimeshKumar923]

Hi @Mayaleeeee 👋

I was checking up earlier because I got the stale notification brought up by the bot comment.

Regardless, I find this as a new addition to the issue section. I would be happy to work on this if you can describe what I've to do in order to setup a new design section in the issue submission section.

As far as I've understood, we need to add a new YAML file here containing the requirements for design issue submission, just like docs issue submission with the YAML code given here

Please elaborate on this further and we can get started on this issue... 👍

[sambhavgupta0705]

@AnimeshKumar923 this will work
just take all the necessary information from @Mayaleeeee and open a pr according to that

[AnimeshKumar923]

@AnimeshKumar923 this will work
just take all the necessary information from @Mayaleeeee and open a pr according to that

Will do this. Currently on a break due to final end semester exams till 25 May.

[Mayaleeeee]

@AnimeshKumar923 this will work
just take all the necessary information from @Mayaleeeee and open a pr according to that

Will do this. Currently on a break due to final end semester exams till 25 May.

Thanks for the update @AnimeshKumar923

[Mayaleeeee]

@AnimeshKumar923 this will work
just take all the necessary information from @Mayaleeeee and open a pr according to that

Will do this. Currently on a break due to final end semester exams till 25 May.

Hello @AnimeshKumar923
Friendly pinging 👋🏾

[AnimeshKumar923]

Thanks for the ping @Mayaleeeee 👍
A bit occupied with this bounty issue currently as it takes more priority... 😅
I'll get back on this soon! 😁

[github-actions]

This issue has been automatically marked as stale because it has not had recent activity 😴

It will be closed in 120 days if no further activity occurs. To unstale this issue, add a comment with a detailed explanation.

There can be many reasons why some specific issue has no activity. The most probable cause is lack of time, not lack of interest. AsyncAPI Initiative is a Linux Foundation project not owned by a single for-profit company. It is a community-driven initiative ruled under open governance model.

Let us figure out together how to push this issue forward. Connect with us through one of many communication channels we established here.

Thank you for your patience ❤️