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.

Sign up for GitHub

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

Jump to bottom

docs: create README for AsyncAPI org profile #72

Closed
quetzalliwrites opened this issue Sep 21, 2021 · 4 comments · Fixed by #76
Closed

docs: create README for AsyncAPI org profile #72

quetzalliwrites opened this issue Sep 21, 2021 · 4 comments · Fixed by #76
Assignees
@quetzalliwrites
Labels
📑 docs enhancement New feature or request

Comments

@quetzalliwrites
Copy link
Member

quetzalliwrites commented Sep 21, 2021 •
edited
Loading

Description

Let's create a README for the AsyncAPI organization profile, now that GH rolled out that new feature. It must be visually appealing and we should agree on what is the best to have there. (@derberg thinks one of main things to put there would be all the communication channels.)
@quetzalliwrites quetzalliwrites added documentation enhancement New feature or request labels Sep 21, 2021
@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.

@derberg
Copy link
Member

derberg commented Sep 22, 2021

yay!

I think that we should expose the communication channels we have listed here -> asyncapi/community#1

in general though, it must be an intro, but imho not necessarily intro to AsyncAPI (as a spec) but intro to AsyncAPI Initiative, our goals, purpose, communication, and important links to blog, roadmap.

and I love these to be nice looking, not just text, but if we link to slack, it should be slack badge and others (we can use https://shields.io/)

@quetzalliwrites quetzalliwrites self-assigned this Sep 22, 2021
@quetzalliwrites quetzalliwrites mentioned this issue Sep 24, 2021
Merged
@quetzalliwrites
Copy link
Member Author

PR is underway! 😄

#76

@quetzalliwrites quetzalliwrites linked a pull request Sep 24, 2021 that will close this issue
docs: creating AsyncAPI organization README #76
Merged
@quetzalliwrites
Copy link
Member Author

Changes are live!!
https://github.com/asyncapi

@vickywane vickywane mentioned this issue Apr 27, 2022
Closed
1 task
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@quetzalliwrites quetzalliwrites

Labels
📑 docs enhancement New feature or request
Projects
AsyncAPI Docs Board
Status: Done 🚀
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

docs: creating AsyncAPI organization README quetzalliwrites/.github
2 participants
@derberg @quetzalliwrites