Skip to content

Commit de92900

Browse files
bandantoniobandantonio
committed
docs: fix coderabbit mentions
1 parent 0800409 commit de92900

File tree

25 files changed

+101
-96
lines changed

25 files changed

+101
-96
lines changed

‎docs/000-onboarding/ambassador-guide.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,4 +38,4 @@ Examples:
3838
- Our sincere gratitude and respect for your contributions!
3939

4040
### Additional resources
41-
[AsyncAPI Ambassador Program](../050-mentorship-program/ambassador-program/AMBASSADOR_PROGRAM.md)
41+
[AsyncAPI Ambassador Program](../020-governance-and-policies/ambassador-program/AMBASSADOR_PROGRAM.md)

‎docs/000-onboarding/documentarian-onboarding-guide.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Documentarian Onboarding Guide
3-
weight: 30
3+
# weight: 30
44
---
55

66
🚧 This document is under construction.

‎docs/000-onboarding/how-to-contribute.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: How to Contribute
3-
weight: 20
3+
# weight: 20
44
---
55

66
🚧 This document is under construction.

‎docs/000-onboarding/where-to-contribute.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Where to Contribute
3-
weight: 10
3+
# weight: 10
44
---
55

66
🚧 This document is under construction.

‎docs/010-contribution-guidelines/conventional-commits.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ The following are some of the most commonly used commit types:
4242

4343
To maintain a clear and structured commit history, all PR titles must follow the Conventional Commits format. This ensures that commit messages and PRs are semantically meaningful and easy to understand.
4444

45-
A PR title that does not follow this format will be rejected by our [Linting bot](../../.github/workflows/lint-pr-title.yml), preventing the PR from being merged.
45+
A PR title that does not follow this format will be rejected by our [Linting bot](https://github.com/asyncapi/community/blob/master/.github/workflows/lint-pr-title.yml), preventing the PR from being merged.
4646

4747
Therefore, you can use the following examples to guide you:
4848

‎docs/011-styleguide/styling.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -210,7 +210,7 @@ They should be clear, optimized, and accessible.
210210

211211
- **JPEG:** For photographs. Optimize for the web to balance quality and file size.
212212

213-
- **Alt Text:** All `<img>` tags must have a descriptive alt attribute for screen readers. If an image is purely decorative, use `alt=""`. In markdown, use the exclamation mark, square brackets and parenthesis combo (`![]()`) to add images, ensure to use a decriptive alt text such as `![a blue bunny](bluebunny.png)`.
213+
- **Alt Text:** All `<img>` tags must have a descriptive alt attribute for screen readers. If an image is purely decorative, use `alt=""`. In markdown, use the exclamation mark, square brackets and parenthesis combo (`![]()`) to add images, ensure to use a descriptive alt text such as `![a blue bunny](bluebunny.png)`.
214214

215215
- **Sizing:** Images should not exceed a maximum width of 800px to avoid overwhelming the content layout.
216216

‎docs/030-project-vision-strategy-goals/2025_Community_Goals.md‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ To improve and streamline the onboarding process for new contributors joining th
3939
### Community Working Group Umbrella
4040
I would like to introduce the Community Working Group, which serves as an umbrella for all community initiatives and programs at AsyncAPI. We have been functioning unofficially as a working group, but it’s time to reorganize, increase visibility for our current programs, and establish a structured approach to how we work.
4141

42-
``` mermaid
42+
```mermaid
4343
flowchart LR
4444
A["**Community Working Group**"] -- Chair By --> B("**Community Manager**")
4545
B --> C("**Community Programs and Initiatives**")
@@ -58,8 +58,7 @@ flowchart LR
5858
classDef Rose stroke-width:1px, stroke-dasharray:none, stroke:#FF5978, fill:#FFDFE5, color:#8E2236
5959
classDef Sky stroke-width:1px, stroke-dasharray:none, stroke:#374D7C, fill:#E2EBFF, color:#374D7C
6060
classDef Aqua stroke-width:1px, stroke-dasharray:none, stroke:#46EDC8, fill:#DEFFF8, color:#378E7A
61-
62-
```
61+
```
6362

6463
The community manager will oversee and chair the working group, which includes community builders responsible for building, leading, and running the programs.
6564
With this structured setup, we will say goodbye to community meetings and hello to the Community WG meeting; this is where we will provide updates on the different programs and the progress the builders are making.

‎docs/030-project-vision-strategy-goals/ROADMAP.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: ROADMAP
3-
weight: 30
3+
# weight: 30
44
---
55

66
🚧 This document is under construction.

‎docs/050-mentorship-program/README.md‎

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -20,26 +20,26 @@ We are also available on the [AsyncAPI slack](https://asyncapi.com/slack-invite)
2020

2121
## Mentoring Programs
2222

23-
| Program | Purpose | Details and historical data |
24-
| --------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------ |
25-
| [AsyncAPI Mentorship](https://www.asyncapi.com/) | Mentoring initiative by AsyncAPI | [asyncapi-mentorship](asyncapi-mentorship/README.md) |
26-
| [Google Summer of Code](https://summerofcode.withgoogle.com/) | Mentoring program for the students | [summerofcode](summerofcode/README.md) |
27-
| [Google Season of Docs](https://developers.google.com/season-of-docs) | Mentoring initiative for technical writers | [seasonofdocs](seasonofdocs/README.md) |
28-
| [Winter of Code](https://www.winterofcode.com) | Mentoring initiative aimed to increase participation for the Google Summer of Code program among students | [winterofcode](winterofcode/README.md) |
29-
| [OpenForce](https://www.openforce.tech/) | The CROSS Research Experiences program provides support for undergraduate and graduate students contributing to CROSS incubator projects. | [openforce](openforce/README.md)
30-
| [Hacktoberfest](https://hacktoberfest.com/) | The idea of Hacktoberfest is to encourage everyone, especially beginners, to contribute to projects that are dear to their hearts. | [hacktoberfest](hacktoberfest/README.md)
23+
| Program | Purpose | Details and historical data |
24+
|-------- | ------- | --------------------------- |
25+
| [AsyncAPI Mentorship](https://www.asyncapi.com/) | Mentoring initiative by AsyncAPI | [asyncapi-mentorship](asyncapi-mentorship/README.md) |
26+
| [Google Summer of Code](https://summerofcode.withgoogle.com/) | Mentoring program for the students | [summerofcode](summerofcode/README.md) |
27+
| [Google Season of Docs](https://developers.google.com/season-of-docs) | Mentoring initiative for technical writers | [seasonofdocs](seasonofdocs/README.md) |
28+
| [Winter of Code](https://www.winterofcode.com) | Mentoring initiative aimed to increase participation for the Google Summer of Code program among students | [winterofcode](winterofcode/README.md) |
29+
| [OpenForce](https://www.openforce.tech/) | The CROSS Research Experiences program provides support for undergraduate and graduate students contributing to CROSS incubator projects. | [openforce](openforce/README.md) |
30+
| [Hacktoberfest](https://hacktoberfest.com/) | The idea of Hacktoberfest is to encourage everyone, especially beginners, to contribute to projects that are dear to their hearts. | [hacktoberfest](hacktoberfest/README.md) |
3131

3232
## Program Statistics
3333

34-
| Year | Program | Participants | Total (per year) |
35-
| ---- | -------------------------------- | ----------- | ---------------- |
36-
| 2023 | AsyncAPI Mentorship | 13 | 40 |
37-
| | GSoD | 5 | |
38-
| | GSoC | 4 | |
39-
| | Hacktoberfest | 18
40-
| 2022 | AsyncAPI Mentorship | 10 | 41 |
41-
| | GSoD | 6 | |
42-
| | Hacktoberfest | 12
43-
| | OpenForce | 13 | |
44-
| 2021 | GSoC | 6 | 32 |
45-
| | Hacktoberfest | 26 | |
34+
| Year | Program | Participants | Total (per year) |
35+
| ---- | -------------------- | ------------ | ---------------- |
36+
| 2023 | AsyncAPI Mentorship | 13 | 40 |
37+
| | GSoD | 5 | |
38+
| | GSoC | 4 | |
39+
| | Hacktoberfest | 18 | |
40+
| 2022 | AsyncAPI Mentorship | 10 | 41 |
41+
| | GSoD | 6 | |
42+
| | Hacktoberfest | 12 | |
43+
| | OpenForce | 13 | |
44+
| 2021 | GSoC | 6 | 32 |
45+
| | Hacktoberfest | 26 | |

‎docs/050-mentorship-program/asyncapi-mentorship/2022/README.md‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -16,16 +16,16 @@ Mentorship duration - seven months \(full-time schedule\)
1616

1717
## Accepted projects
1818

19-
Number | Idea | Area | Lead mentor | Votes | Mentee?
20-
---|---|---|---|--- | ---
21-
8 | [Drag&drop AsyncAPI block builder](https://github.com/asyncapi/studio/issues/265) | [Studio](https://github.com/asyncapi/studio) | @magicmatatjahu | 10 | @wh0sumit
22-
4 | [Add support for Kafka](https://github.com/asyncapi/glee/issues/256) | [Glee](https://github.com/asyncapi/glee) | @fmvilas | 9 | @Ruchip16
23-
18 | [Add support for retries, backpressure, and at-most-once, at-least-once, and exactly-once semantics](https://github.com/asyncapi/glee/issues/27) | [Glee](https://github.com/asyncapi/glee) | @fmvilas | 9 | @sudoshreyansh
24-
9 | [Website UI Kit design/dev project](https://github.com/asyncapi/design-system/issues/4) | [Design System](https://github.com/asyncapi/design-system) | @mcturco | 8 | @yashsehgal @Mayaleeeee
25-
1 | [Add support for HTTP servers and clients](https://github.com/asyncapi/glee/issues/260) | [Glee](https://github.com/asyncapi/glee) | @Souvikns | 7 | @ritik307
26-
<del>6</del> | <del>[Library for easier integration testing of code generators](https://github.com/asyncapi/generator/issues/752)</del> | [Generator](https://github.com/asyncapi/generator) | @derberg | 7 | https://github.com/asyncapi/community/discussions/376#discussioncomment-2898788
27-
10 | [An interface/project for describing errors/problems in tools in our organization](https://github.com/asyncapi/community/issues/266) | New library | @magicmatatjahu | 7 | @imabp
28-
13 | [Build a React app to visualize GitHub Actions across the organization](https://github.com/asyncapi/.github/issues/136) | AsyncAPI CI/CD | @KhudaDad414 | 6 | @Samridhi-98
29-
14 | [MVP integration of extensions catalog with AsyncAPI tools to make extension catalog useful](https://github.com/asyncapi/extensions-catalog/issues/78) | [Extension Catalog](https://github.com/asyncapi/extensions-catalog) | @derberg | 6 | @Sihamtahi
30-
16 | [Create New page for /tools/](https://github.com/asyncapi/website/issues/383) | [Website](https://github.com/asyncapi/website) | @derberg | 6 | @akshatnema
19+
Number | Idea | Area | Lead mentor | Votes | Mentee? |
20+
---|---|---|---|---|---|
21+
8 | [Drag&drop AsyncAPI block builder](https://github.com/asyncapi/studio/issues/265) | [Studio](https://github.com/asyncapi/studio) | @magicmatatjahu | 10 | @wh0sumit |
22+
4 | [Add support for Kafka](https://github.com/asyncapi/glee/issues/256) | [Glee](https://github.com/asyncapi/glee) | @fmvilas | 9 | @Ruchip16 |
23+
18 | [Add support for retries, backpressure, and at-most-once, at-least-once, and exactly-once semantics](https://github.com/asyncapi/glee/issues/27) | [Glee](https://github.com/asyncapi/glee) | @fmvilas | 9 | @sudoshreyansh |
24+
9 | [Website UI Kit design/dev project](https://github.com/asyncapi/design-system/issues/4) | [Design System](https://github.com/asyncapi/design-system) | @mcturco | 8 | @yashsehgal @Mayaleeeee |
25+
1 | [Add support for HTTP servers and clients](https://github.com/asyncapi/glee/issues/260) | [Glee](https://github.com/asyncapi/glee) | @Souvikns | 7 | @ritik307 |
26+
<del>6</del> | <del>[Library for easier integration testing of code generators](https://github.com/asyncapi/generator/issues/752)</del> | [Generator](https://github.com/asyncapi/generator) | @derberg | 7 | https://github.com/asyncapi/community/discussions/376#discussioncomment-2898788 |
27+
10 | [An interface/project for describing errors/problems in tools in our organization](https://github.com/asyncapi/community/issues/266) | New library | @magicmatatjahu | 7 | @imabp |
28+
13 | [Build a React app to visualize GitHub Actions across the organization](https://github.com/asyncapi/.github/issues/136) | AsyncAPI CI/CD | @KhudaDad414 | 6 | @Samridhi-98 |
29+
14 | [MVP integration of extensions catalog with AsyncAPI tools to make extension catalog useful](https://github.com/asyncapi/extensions-catalog/issues/78) | [Extension Catalog](https://github.com/asyncapi/extensions-catalog) | @derberg | 6 | @Sihamtahi |
30+
16 | [Create New page for /tools/](https://github.com/asyncapi/website/issues/383) | [Website](https://github.com/asyncapi/website) | @derberg | 6 | @akshatnema |
3131

0 commit comments

Comments
 (0)