You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
As an open-source initiative with a global community, technical writer contributors should learn about our governance documents, documentation processes, and communication channels.
8
8
9
9
Complete in order the following onboarding tasks:
10
10
11
-
-[ ] Read the [AsyncAPI Code of Conduct](https://github.com/asyncapi/community/blob/master/CODE_OF_CONDUCT.md).
12
-
-[ ] Read the [AsyncAPI Slack etiquette](https://github.com/asyncapi/community/blob/master/slack-etiquette.md).
11
+
-[ ] Read the [AsyncAPI Code of Conduct](https://github.com/asyncapi/.github/blob/master/CODE_OF_CONDUCT.md).
12
+
-[ ] Read the [AsyncAPI Slack etiquette](../060-meetings-and-communication/slack-etiquette.md).
-[ ] Add the AsyncAPI calendar found in [the AsyncAPI events page](https://www.asyncapi.com/community/events).
15
-
-[ ] Read the list of [technical writer contributor responsibilities](../010-contribution-guidelines/technical-writer-contributor-responsibilities).
16
-
-[ ] Read and familiarize yourself with the [prerequisite knowledge topics](../010-contribution-guidelines/prerequisite-knowledge).
15
+
-[ ] Read the list of [technical writer contributor responsibilities](../010-contribution-guidelines/technical-writer-contributor-responsibilities.md).
16
+
-[ ] Read and familiarize yourself with the [prerequisite knowledge topics](../010-contribution-guidelines/prerequisite-knowledge.md).
17
17
-[ ] Familiarize yourself with the _work-in-progress_[AsyncAPI Style Guide](https://github.com/asyncapi/community/pulls?q=is%3Apr+is%3Aopen+style+guide).
18
18
-[ ] Read all docs under the following content buckets: `Concepts`, `Tutorials`, `Reference`. (Take the time to go through each tutorial.)
19
-
-[ ] Set up your local environment following our instructions for the [AsyncAPI git workflow](https://github.com/asyncapi/community/blob/master/git-workflow.md).
19
+
-[ ] Set up your local environment following our instructions for the [AsyncAPI git workflow](../010-contribution-guidelines/git-workflow.md).
20
20
-[ ] Introduce yourself in AsyncAPI Slack in the `#01_introductions` channel and the `#13_docs` channel. Ask docs-related questions in #13_docs.
21
21
-[ ] Request a good first docs issue in the [`#13_docs` Slack channel](https://asyncapi.com/slack-invite).
22
22
-[ ] Attend [OPEN docs meetings](https://www.asyncapi.com/community/events) to chat with other maintainers, ask docs questions, and request help on docs blockers.
Copy file name to clipboardExpand all lines: docs/000-onboarding/index.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,12 +1,12 @@
1
1
---
2
-
title: 'Introduction'
3
-
weight: 10
2
+
title: Introduction
3
+
weight: 5
4
4
---
5
5
## Technical writer onboarding guide
6
6
7
7
The AsyncAPI technical writer onboarding guide teaches new community members how to contribute to our documentation effectively.
8
8
9
-
> 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).
9
+
> For a comprehensive understanding of the various ways you can contribute to the AsyncAPI Initiative, please consult the [AsyncAPI contributing guidelines](../../CONTRIBUTING.md).
10
10
11
11
The goal is providing docs contributors with the necessary tools and knowledge to:
Copy file name to clipboardExpand all lines: docs/000-onboarding/maintainer-guide.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
---
2
2
title: Onboarding Guide for AsyncAPI Maintainers
3
-
weight: 100
3
+
weight: 40
4
4
---
5
5
6
6
@@ -46,7 +46,7 @@ Before you can become a **maintainer**, you need to start as a **contributor**.
46
46
47
47
### 2. Open a PR
48
48
49
-
For a comprehensive guide on how to create a fork and start contributing, refer to the [AsyncAPI Git Workflow Guide](https://github.com/asyncapi/community/blob/master/git-workflow.md).
49
+
For a comprehensive guide on how to create a fork and start contributing, refer to the [AsyncAPI Git Workflow Guide](../010-contribution-guidelines/git-workflow.md).
50
50
51
51
-**Fork the repository**: Fork the repository you want to contribute to and create a new branch for your changes.
Copy file name to clipboardExpand all lines: docs/000-onboarding/upholding-code-of-conduct.md
+7-7Lines changed: 7 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,12 +1,12 @@
1
1
---
2
-
title: Upholding the Code of Conduct for new contributors
2
+
title: Upholding the Code of Conduct
3
3
description: This onboarding guide outlines how to uphold the Code of Conduct document for new contributors
4
-
weight: 160
4
+
weight: 70
5
5
---
6
6
7
7
# Contributor Guide to Upholding the Code of Conduct
8
8
9
-
Welcome to the AsyncAPI community! As a contributor, you are an essential part of building a safe, inclusive, and respectful environment for everyone. This guide will help you understand how to follow and uphold our [Code of Conduct](https://github.com/asyncapi/community/blob/master/CODE_OF_CONDUCT.md).
9
+
Welcome to the AsyncAPI community! As a contributor, you are an essential part of building a safe, inclusive, and respectful environment for everyone. This guide will help you understand how to follow and uphold our [Code of Conduct](https://github.com/asyncapi/.github/blob/master/CODE_OF_CONDUCT.md).
10
10
11
11
12
12
@@ -29,7 +29,7 @@ Following it helps:
29
29
-**Be community-oriented:** Encourage collaboration, help others when you can, and gracefully accept constructive criticism.
30
30
-**Speak Up:** If you witness inappropriate behavior, report it.
31
31
32
-
You are expected to read and understand the full [CoC](https://github.com/asyncapi/community/blob/master/CODE_OF_CONDUCT.md) before contributing.
32
+
You are expected to read and understand the full [CoC](https://github.com/asyncapi/.github/blob/master/CODE_OF_CONDUCT.md) before contributing.
33
33
34
34
35
35
## What to Do If You Experience or Witness a Violation
@@ -44,7 +44,7 @@ If you experience or observe discrimination, harassment, or any behavior that vi
44
44
### 2. Report the Incident
45
45
You can report a CoC violation by:
46
46
47
-
- Emailing **conduct@asyncapi.io** – this forwards directly to the [Code of Conduct Committee](https://github.com/asyncapi/community/blob/master/code_of_conduct/code-of-conduct-committee.md)
47
+
- Emailing **conduct@asyncapi.io** – this forwards directly to the [Code of Conduct Committee](../CODE_OF_CONDUCT_COMMITTEE.md)
48
48
- Reaching out to a specific CoC Committee member if the issue involves someone on the committee
49
49
50
50
All reports are handled with confidentiality, respect, and prompt action.
@@ -61,5 +61,5 @@ The Code of Conduct Committee is trained to resolve conflicts fairly and ensure
0 commit comments