docs: add info about working groups #1075
Conversation
fmvilas
requested review from
quetzalliwrites,
derberg,
asyncapi-bot-eve and
thulieblack
as code owners
|
Just drafted an initial version of this information. Please let me know if something should or shouldn't be required, or if something is missing. |
| # chairperson: Required. GitHub handle of the chairperson. Example: @Barbanio. | ||
| # members: # Required to have at least 2 members who are not the same as the chairperson. | ||
| # - @fmvilas # GitHub handle of the member. | ||
| # okrs_url: https://example.com/xyz # Required. Link to a GitHub project, issue, or any other tool where the Working Group explains their objectives. |
There was a problem hiding this comment.
Not sure if this should be required. As per the rules described in the Markdown file, it's required but I'm happy to change it if you think otherwise.
There was a problem hiding this comment.
GitHub teams can be mentioned also as suggested by @Souvikns for better transparency and easy tagging.
There was a problem hiding this comment.
Thanks for reminding me. Also added Slack channel 👍
Co-authored-by: Fran Méndez <[email protected]>
|
Awesome! Thanks for the changes, @thulieblack 🙌 |
|
/rtm |
| working_groups: | ||
| # - name: Required. The name of the working group. | ||
| # description: Required. Describe what this working group is about. | ||
| # chairperson: Required. GitHub handle of the chairperson. Example: @Barbanio. |
There was a problem hiding this comment.
what if there are 2 or more chairpersons? better to have it as list imho, like in case of members
There was a problem hiding this comment.
@fmvilas fyi, yeah, it was merged before I had a chance to look into it
There was a problem hiding this comment.
Apologies. Just realized about your comments right now. Will open a separate PR.
| # members: # Required to have at least 2 members who are not the same as the chairperson. | ||
| # - @fmvilas # GitHub handle of the member. | ||
| # slack_channel: # Required. The name of the Slack channel in the AsyncAPI workspace. Example: community_growth_wg | ||
| # okrs_url: https://example.com/xyz # Required. Link to a GitHub project, issue, or any other tool where the Working Group explains their objectives. |
There was a problem hiding this comment.
there's no single sentence about ORKs in WORKING_GROUPS.md - so the name of property can be pretty confusing. And why required? I could also add ORKs as a bullet list here in YAML to get it rendered in website. Maybe just call it goals and define it as a field where you can write goals or provide link?
and I immediately ask what is the difference with roadmap_url - why separate link?
There was a problem hiding this comment.
@fmvilas fyi, yeah, it was merged before I had a chance to look into it
There was a problem hiding this comment.
Apologies. Just realized about your comments right now. Will open a separate PR.
There was a problem hiding this comment.
Just created a PR: #1138. Regarding differences between objectives and roadmap, have a look at DX working group details. Long story short, objectives are for setting direction (the why), roadmap is exactly the issues/tasks (the what and how) you're going to be addressing in the foreseeable future (in their case 6 weeks).
Description
Adds info about how working groups work and an initial WORKING_GROUPS.yaml file with an example on how to define a working group.
Once this is merged. I'll start pinging people so they create individual PRs for the first working groups.
Related issue(s)
https://github.com/orgs/asyncapi/discussions/1037