Skip to content

Commit

Permalink
Merge branch 'update' into update
Browse files Browse the repository at this point in the history
  • Loading branch information
quetzalliwrites authored Feb 1, 2024
2 parents 6cd3727 + e57989b commit 2320614
Show file tree
Hide file tree
Showing 12 changed files with 198 additions and 5 deletions.
3 changes: 2 additions & 1 deletion .github/workflows/maintainers-tsc-changes-verification.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,8 @@ jobs:
- name: Checkout PR branch
uses: actions/checkout@v3
with:
ref: ${{ github.head_ref }}
ref: ${{github.event.pull_request.head.ref}}
repository: ${{github.event.pull_request.head.repo.full_name}}
path: pr-branch

- name: Install js-yaml
Expand Down
26 changes: 22 additions & 4 deletions AMBASSADORS_MEMBERS.json
Original file line number Diff line number Diff line change
Expand Up @@ -270,10 +270,10 @@
"github": "M3lkior",
"twitter": "ldussart",
"country": "🇫🇷",
"bio": "Ludovic has been working for Ineat for the last 10 years. Starting as a java developer, he is now a Solutions Architect, working with his customers to build EDA-oriented digital products wherever possible. His first contributions to AsyncAPI date back to 2020 around the kafka and avro specifications. Since then, Ludovic has been spreading the word about AsyncAPI to companies in Northern France, to accelerate adoption of the initiative.",
"bio": "Ludovic is a Solutions Architect, working with his customers to build EDA-oriented digital products wherever possible. His first contributions to AsyncAPI date back to 2020 around the kafka and avro specifications. Since then, Ludovic has been spreading the word about AsyncAPI to companies in Northern France, to accelerate adoption of the initiative.",
"linkedin": "ludovic-dussart-846a8063",
"company": "Ineat",
"title": "Solutions Architect",
"company": "zatsit",
"title": "Solutions Architect / DevRel",
"img": "https://avatars.githubusercontent.com/u/5501911?s=400&u=d3f33c22f67788aba810ba8e910452aff62ad7c9&v=4",
"contributions": [
{
Expand Down Expand Up @@ -354,7 +354,7 @@
"date": {
"year": 2023
},
"link": ""
"link": "https://www.asyncapi.com/casestudies/adeogroup"
},
{
"type": "presentation",
Expand All @@ -372,7 +372,25 @@
"year": 2023,
"month": "October"
},
"link": "https://www.youtube.com/watch?v=pFMmQVppV6s"
},
{
"type": "special contribution",
"title": "Stay at API Days AsyncAPI Booth to share with attendees.",
"date": {
"year": 2023,
"month": "December"
},
"link": ""
},
{
"type": "presentation",
"title": "Quoi de neuf dans AsyncAPI v3 ? Découvrez le en live avec la migration du use-case Adeo",
"date": {
"year": 2023,
"month": "December"
},
"link": "https://www.youtube.com/watch?v=WCK9_ZDv6K4"
}
]
},
Expand Down
28 changes: 28 additions & 0 deletions MAINTAINERS.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,15 @@
isTscMember: true
repos:
- cupid
- name: Ashish Padhy
github: Shurtu-gal
linkedin: ashish-padhy3023
slack: U0572R8J927
twitter: Shurtu_Gal
availableForHire: true
isTscMember: true
repos:
- github-action-for-cli
- name: Cameron Rushton
github: cameronrushton
slack: U01DVKKAV5K
Expand Down Expand Up @@ -286,6 +295,16 @@
isTscMember: true
repos:
- bindings
- name: Samir AMZANI
github: Amzani
slack: U01N6AW5V5G
twitter: amzani
linkedin: amzani
availableForHire: false
company: Postman
isTscMember: true
repos:
- studio
- name: Sergio Moya
github: smoya
linkedin: smoya
Expand Down Expand Up @@ -516,3 +535,12 @@
repos:
- website
- community
- name: Ashmit JaiSarita Gupta
github: devilkiller-ag
linkedin: jaisarita
twitter: jaisarita
slack: U062LA14E58
availableForHire: true
isTscMember: true
repos:
- modelina
4 changes: 4 additions & 0 deletions docs/onboarding-guide/_section.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
title: Onboarding guide
weight: 10
---
27 changes: 27 additions & 0 deletions docs/onboarding-guide/docs-community.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
---
title: 'AsyncAPI docs community'
weight: 50
---

Join OPEN docs community meetings via Zoom, a regular space for docs contributors to meet and help each other.

- Add the AsyncAPI calendar [in the AsyncAPI events page](https://www.asyncapi.com/community/events) to get docs meetings automatically added to your calendar of choice.
- Watch past AsyncAPI docs meetings on the [AsyncAPI YouTube channel](https://www.youtube.com/AsyncAPI).
- [Schedule your own docs meetings](https://github.com/asyncapi/community/blob/master/MEETINGS_ORGANIZATION.md).

### Docs and education community discussions
Visit the [public AsyncAPI Docs & Education discussion board](https://github.com/orgs/asyncapi/discussions/categories/docs-education) to discuss docs-related issues and propose improvements.

## AsyncAPI Slack workspace and docs channels
Join the [AsyncAPI documentation Slack channel](https://join.slack.com/share/enQtNjUxNTY1NTU1MDk0NS1mYjNhODFhZDI3ZDRjODA1ZWRkZTZlYmM4ZTNjNzZjNTg5NTBiYjNmNTkwYzRlYzY4ZjQ4M2RhMDYzMjI3N2U5) to meet other technical writers:

- **#13_docs:** A space for all technical writers to start discussions, ask questions, share new ideas, and request `good first issues.`

## AsyncAPI documentation roadmap 2024
Stay tuned for new opportunities on our [Docs’ Community discussions](https://github.com/orgs/asyncapi/discussions/categories/docs-education) or reach out in the AsyncAPI Slack channel **#13_docs**.

| Docs Roadmap | Ongoing Docs Projects | Timeline | Contribution Type |
|--------------|-----------------------|----------|---------------------|
| AsyncAPI Style Guide | [AsyncAPI Style Guide](https://github.com/asyncapi/website/issues/1240) | Ongoing | Regular contribution |
| AsyncAPI Tools’ Docs | <li>[Modelina Docs](https://github.com/asyncapi/modelina/tree/master/docs) </li> <li>[Parser Docs](https://github.com/asyncapi/parser-js/tree/master/docs) </li> <li>[GitHub Actions Docs](https://github.com/asyncapi/github-action-for-generator)</li> <li>[Studio Docs](https://github.com/asyncapi/studio/tree/master/doc/adr)</li> <li>[Generator Docs](https://github.com/asyncapi/generator/tree/master/docs)</li> <li>[CLI Docs](https://github.com/asyncapi/cli/tree/master/docs)</li> | Ongoing | Regular contribution |
| Technical Writer Onboarding Guide | Onboarding Guide for new docs contributors | Ongoing | Regular contribution |
22 changes: 22 additions & 0 deletions docs/onboarding-guide/docs-onboarding-checklist.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
title: 'Docs onboarding checklist'
weight: 30
---
## AsyncAPI docs onboarding checklist

As an open-source initiative with a global community, technical writer contributors should learn about our governance documents, documentation processes, and communication channels.

Complete in order the following onboarding tasks:

- [ ] Read the [AsyncAPI Code of Conduct](https://github.com/asyncapi/community/blob/master/CODE_OF_CONDUCT.md).
- [ ] Read the [AsyncAPI Slack etiquette](https://github.com/asyncapi/community/blob/master/slack-etiquette.md).
- [ ] Join [the AsyncAPI Slack workspace](https://asyncapi.com/slack-invite).
- [ ] Add the AsyncAPI calendar found in [the AsyncAPI events page](https://www.asyncapi.com/community/events).
- [ ] Read the list of [technical writer contributor responsibilities](/docs/onboarding-guide/technical-writer-contributor-responsibilities.md).
- [ ] Read and familiarize yourself with the [prerequisite knowledge topics](/docs/onboarding-guide/prerequisite-knowledge.md).
- [ ] Familiarize yourself with the _work-in-progress_ [AsyncAPI Style Guide](https://github.com/asyncapi/community/pulls?q=is%3Apr+is%3Aopen+style+guide).
- [ ] Read all docs under the following content buckets: `Concepts`, `Tutorials`, `Reference`. (Take the time to go through each tutorial.)
- [ ] Set up your local environment following our instructions for the [AsyncAPI git workflow](https://github.com/asyncapi/community/blob/master/git-workflow.md).
- [ ] Introduce yourself in AsyncAPI Slack in the `#01_introductions` channel and the `#13_docs` channel. Ask docs-related questions in #13_docs.
- [ ] Request a good first docs issue in the [`#13_docs` Slack channel](https://asyncapi.com/slack-invite).
- [ ] Attend [OPEN docs meetings](https://www.asyncapi.com/community/events) to chat with other maintainers, ask docs questions, and request help on docs blockers.
22 changes: 22 additions & 0 deletions docs/onboarding-guide/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
title: 'Introduction'
weight: 10
---
## Technical writer onboarding guide

The AsyncAPI technical writer onboarding guide teaches new community members how to contribute to our documentation effectively.

> For a comprehensive understanding of the various ways you can contribute to the AsyncAPI Initiative, please consult the [AsyncAPI contributing guidelines](https://github.com/asyncapi/community/blob/master/CONTRIBUTING.md).
The goal is providing docs contributors with the necessary tools and knowledge to:

* Understand our documentation tools, technologies, and processes.
* Comprehend our documentation target audiences.
* Connect with teammates and subject matter experts (SMEs).
* Report documentation bugs via issues.
* Implement and propose updates to our documentation.
* Obtain and incorporate reviewers' feedback.
* Publish changes successfully.



36 changes: 36 additions & 0 deletions docs/onboarding-guide/prerequisite-knowledge.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
---
title: 'Prerequisite knowledge'
weight: 40
---

The prerequisite knowledge section highlights the key technologies, concepts, and skills our technical writers need for working with AsyncAPI documentation. You must understand the main concepts behind our documentation processes, content classification, and the AsyncAPI specification.

## Diátaxis framework and content buckets
AsyncAPI adopted the [Diátaxis](https://diataxis.fr/) framework to meet our specific needs, classifying our documentation into content buckets (categories).

- `Concepts` define the concepts of AsyncAPI features.
- `Tutorials` teach beginner processes with AsyncAPI by doing, taking you step-by-step from Point A to Point B.
- `Tools` documents the AsyncAPI tools ecosystem.
- `Guide` teaches troubleshooting and understanding AsyncAPI's capabilities at a high level.
- `Reference` documents the AsyncAPI specification.
- `Migration` guides how to upgrade to a newer AsyncAPI version.
- `Community` explains our documentation processes, guidelines, and resources to community members.

## Markdown syntax and `mermaid.js` diagrams
AsyncAPI's docs are written in [Markdown syntax](https://www.markdownguide.org/basic-syntax/).

Our diagrams are created with [Mermaid markdown syntax](https://mermaid.live/) thanks to the [mermaid.js](https://mermaid.js.org/) dependency.

## AsyncAPI concepts
Before contributing to the documentation, you should understand [the purpose of AsyncAPI](https://www.asyncapi.com/docs/tutorials/getting-started) and essential [AsyncAPI concepts](https://www.asyncapi.com/docs/concepts) _(i.e., servers, producers, consumers, channels, messages, etc.)_.

You should also fundamentally understand [the AsyncAPI specification](https://www.asyncapi.com/docs/reference/specification/latest).

## JSON and YAML
Because an AsyncAPI definition can be written in JSON and YAML, you must learn how to read, write, and validate these formats.

## Understanding Event-Driven Architecture
[Event-Driven Architecture (EDA)](https://www.asyncapi.com/docs/tutorials/getting-started/event-driven-architectures/) uses events to trigger and communicate between services. (AsyncAPI is an open-source initiative that seeks to improve the current state of EDAs.)

## Protocols used with AsyncAPI
AsyncAPI supports several protocols, such as Kafka, AMQP, MQTT, and more. You will benefit from acquiring a [basic understanding of protocols most used with AsyncAPI](https://www.asyncapi.com/docs/concepts/protocol), including their use cases and how they work with AsyncAPI.
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
title: 'Technical writer contributor responsibilities'
weight: 20
---

In the AsyncAPI community, technical writers collaborate with other technical writers, Subject Matter Experts (SME), designers, engineers, and core maintainers.

Technical writer contributor responsibilities include:

* Create quality, easy-to-use, clear, and accurate documentation for all audience levels.
* Collaborate with other contributors to propose, create, and maintain documentation.
* Support fellow technical writers and community members.
* Engage in documentation review processes and incorporate feedback.
* Join documentation community meetings/streams to connect with the community.
7 changes: 7 additions & 0 deletions tweets/recurring-slack-link/2024-01-13.tweet
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
✨ Did you know #AsyncAPI is on Slack? ✨

Join our Slack workspace to chat with anyone from our Open-Source community!

🔗 asyncapi.com/slack-invite

Ask for help and help others too. 💪🏿💪🏽🦾
7 changes: 7 additions & 0 deletions tweets/recurring-slack-link/2024-01-20.tweet
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
✨ Did you know #AsyncAPI is on Slack? ✨

Join our Slack workspace to chat with anyone from our Open-Source community!

🔗 asyncapi.com/slack-invite

Ask for help and help others too. 💪🏿💪🏽🦾
7 changes: 7 additions & 0 deletions tweets/recurring-slack-link/2024-01-27.tweet
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
✨ Did you know #AsyncAPI is on Slack? ✨

Join our Slack workspace to chat with anyone from our Open-Source community!

🔗 asyncapi.com/slack-invite

Ask for help and help others too. 💪🏿💪🏽🦾

0 comments on commit 2320614

Please sign in to comment.