Skip to content
Merged
Show file tree
Hide file tree
Changes from 11 commits
Commits
Show all changes
20 commits
Select commit Hold shift + click to select a range
eb901fb
docs: add section definitions to updated structure
bandantonio Jul 4, 2025
285fc22
docs: update weights for guides in onboarding section
bandantonio Jul 4, 2025
0db8d64
docs: update weights for guides in contribution section
bandantonio Jul 4, 2025
c9bc6b1
docs: update weights for guides in style guide section
bandantonio Jul 5, 2025
7be4b6c
docs: update weights for guides in governance section
bandantonio Jul 5, 2025
52b1b89
docs: update weights for guides in vision and strategy section
bandantonio Jul 5, 2025
4ff3e00
docs: update weights for guides in guides section
bandantonio Jul 5, 2025
3b38dae
docs: update weights for mentorship section
bandantonio Jul 5, 2025
6f2a5ae
docs: update weights for meetings and communication section
bandantonio Jul 5, 2025
cb0e2e4
docs: update weights for marketing section
bandantonio Jul 5, 2025
51671fa
Merge branch 'master' into docs/weights-and-frontmatter
asyncapi-bot Jul 6, 2025
8ccf704
Merge branch 'master' into docs/weights-and-frontmatter
thulieblack Jul 8, 2025
f4003f7
docs: update links to files after structure update (cherry-pick)
bandantonio Jul 6, 2025
df6c4ae
docs: update weights after changing structure
bandantonio Jul 9, 2025
9bdd108
docs: fix linting errors
bandantonio Jul 9, 2025
82a13c9
Merge branch 'master' into docs/weights-and-frontmatter
thulieblack Jul 11, 2025
0994682
Merge branch 'master' into docs/weights-and-frontmatter
thulieblack Jul 15, 2025
1113c67
docs: add index pages to new structure sections
bandantonio Jul 15, 2025
ec4993b
docs: update headings in section index pages
bandantonio Jul 17, 2025
0800409
Merge branch 'master' into docs/weights-and-frontmatter
thulieblack Jul 23, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/000-onboarding/_section.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
---
title: Onboarding guide
title: Onboarding
weight: 10
---
4 changes: 2 additions & 2 deletions docs/000-onboarding/ambassador-guide.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Onboarding Guide for AsyncAPI Ambassadors
weight: 110
weight: 50
---


Expand Down Expand Up @@ -38,4 +38,4 @@ Examples:
- Our sincere gratitude and respect for your contributions!

### Additional resources
[AsyncAPI Ambassador Program](https://github.com/asyncapi/community/blob/master/AMBASSADOR_ORGANIZATION.md)
[AsyncAPI Ambassador Program](../050-mentorship-program/ambassador-program/AMBASSADOR_PROGRAM.md)
4 changes: 2 additions & 2 deletions docs/000-onboarding/docs-onboarding-checklist.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: 'Docs onboarding checklist'
weight: 30
title: Docs Onboarding Checklist
weight: 60
---
## AsyncAPI docs onboarding checklist

Expand Down
5 changes: 5 additions & 0 deletions docs/000-onboarding/documentarian-onboarding-guide.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: Documentarian Onboarding Guide
weight: 30
---

🚧 This document is under construction.

Please be patient as we work on it. Thank you. 🫶
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: 'Utilizing GitHub Actions'
weight: 140
title: Utilizing GitHub Actions
weight: 80
---

## Overview
Expand Down
5 changes: 5 additions & 0 deletions docs/000-onboarding/how-to-contribute.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: How to Contribute
weight: 20
---

🚧 This document is under construction.

Please be patient as we work on it. Thank you. 🫶
4 changes: 2 additions & 2 deletions docs/000-onboarding/index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: 'Introduction'
weight: 10
title: Introduction
weight: 5
---
## Technical writer onboarding guide

Expand Down
2 changes: 1 addition & 1 deletion docs/000-onboarding/maintainer-guide.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Onboarding Guide for AsyncAPI Maintainers
weight: 100
weight: 40
---


Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Upholding the Code of Conduct for new contributors
title: Upholding the Code of Conduct
description: This onboarding guide outlines how to uphold the Code of Conduct document for new contributors
weight: 160
weight: 70
---

# Contributor Guide to Upholding the Code of Conduct
Expand Down
5 changes: 5 additions & 0 deletions docs/000-onboarding/where-to-contribute.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: Where to Contribute
weight: 10
---

🚧 This document is under construction.

Please be patient as we work on it. Thank you. 🫶
5 changes: 5 additions & 0 deletions docs/010-contribution-guidelines/BOUNTY_PROGRAM.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: AsyncAPI Bounty Program
weight: 160
---

# AsyncAPI Bounty Program


Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: Become Maintainer in Existing Project
weight: 140
---

### Become Maintainer in Existing Project

We know you are nervous about making your first contribution. In this section, we guide you on the steps towards becoming a TSC member:
Expand Down
4 changes: 4 additions & 0 deletions docs/010-contribution-guidelines/_section.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
title: Contribution Guidelines
weight: 20
---
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: AsyncAPI Code Contributor Guide
description: A guide for new contributors looking to contribute code to the AsyncAPI project.
weight: 90
weight: 70
---
# AsyncAPI Code Contributor Guide

Expand Down
5 changes: 5 additions & 0 deletions docs/010-contribution-guidelines/contribute-blog-post.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: Contribute AsyncAPI Blog Posts
weight: 90
---

## Contribute AsyncAPI blog posts

The AsyncAPI blog is open to everyone; any contribution is allowed, including reposting. You can share use cases, projects, or tools in the form of a blog post to reach out to the entire AsyncAPI community.
Expand Down
2 changes: 1 addition & 1 deletion docs/010-contribution-guidelines/contribute-to-docs.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Contribute to docs
weight: 70
weight: 80
---

## Contribute to docs
Expand Down
4 changes: 2 additions & 2 deletions docs/010-contribution-guidelines/contribution-flow.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Simple contribution flow for contributors
weight: 130
title: Simple Contribution Flow
weight: 20
---

# Simple Contribution Flow
Expand Down
2 changes: 1 addition & 1 deletion docs/010-contribution-guidelines/conventional-commits.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Following Conventional Commits
description: This guide teaches you how to write clear and structured commit messages using the Conventional Commits standard.
weight: 120
weight: 60
---

When you contribute to a project, you're not just adding code or docs but also context. Your changes become part of the project's history, and your commit messages explain why the changes were made.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title : 'Create new docs directories'
weight : 80
title: Create New Docs Directories
weight: 120
---

### Create new docs directories
Expand Down
5 changes: 5 additions & 0 deletions docs/010-contribution-guidelines/git-workflow.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: Git Workflow
weight: 50
---

# Git Workflow

This document is the best practice guide that contains the rules to follow when working with AsyncAPI repositories.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Identifying Good First Issues
description: A guide to help new contributors find and work on beginner-friendly issues in AsyncAPI projects
weight: 50
weight: 40
---

# Identifying Good First Issues
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Strategies for mentoring new maintainers
title: Strategies for Mentoring New Maintainers
description: This onboarding guide suggests important strategies that are helpful in mentoring new maintainers.
weight: 150
---
Expand Down
4 changes: 2 additions & 2 deletions docs/010-contribution-guidelines/open-docs-pull-request.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title : 'Create new docs pull request'
weight : 90
title: Create New Docs Pull Request
weight: 110
---

## Create a new docs pull request
Expand Down
4 changes: 2 additions & 2 deletions docs/010-contribution-guidelines/prerequisite-knowledge.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: 'Prerequisite knowledge'
weight: 40
title: Prerequisite Knowledge
weight: 10
---

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.
Expand Down
5 changes: 5 additions & 0 deletions docs/010-contribution-guidelines/recognize-contributors.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: Recognize Contributors
weight: 130
---

# Recognize Contributors

We do our best to recognize every contribution to the project. We do it individually in every repository from the AsyncAPI GitHub organization.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: 'Technical writer contributor responsibilities'
weight: 20
title: Technical Writer Contributor Responsibilities
weight: 100
---

In the AsyncAPI community, technical writers collaborate with other technical writers, Subject Matter Experts (SME), designers, engineers, and core maintainers.
Expand Down
4 changes: 2 additions & 2 deletions docs/010-contribution-guidelines/tools-and-setup.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Recommended tools and setup
weight: 60
title: Recommended Tools and Setup
weight: 30
---

These are the recommended tools for contributors, as well as instructions for setting up the AsyncAPI website in your local environment.
Expand Down
6 changes: 3 additions & 3 deletions docs/011-styleguide/_section.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
---
title: Style guide
weight: 5
---
title: Style Guide
weight: 30
---
2 changes: 1 addition & 1 deletion docs/011-styleguide/content-buckets.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Content Buckets
Description: This style guide explains how and why we use content buckets in documentation.
weight: 30
weight: 40
---

# Content Buckets
Expand Down
2 changes: 1 addition & 1 deletion docs/011-styleguide/formatting.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Formatting
description: This guide illustrates the standards for formatting and writing our documentation.
weight: 110
weight: 100
---

## Documentation formatting
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Glossary
description: The style guide gives advice on how to effectively use terms and concepts when creating tutorials and other forms of content for AsyncAPI.
weight: 180
weight: 160
---
## What is the purpose of the glossary?

Expand Down
2 changes: 1 addition & 1 deletion docs/011-styleguide/grammar.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Grammar
description: The style guide gives advice on how to implement grammar when creating tutorials and other forms of content for AsyncAPI.
weight: 100
weight: 70
---

## Abbreviations and acronyms
Expand Down
2 changes: 1 addition & 1 deletion docs/011-styleguide/inclusive-language.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Inclusive Language style guide
description: This style guide outlines the guidelines for using inclusive language in documentation.
weight: 60
weight: 50
---

# Inclusive Language
Expand Down
2 changes: 1 addition & 1 deletion docs/011-styleguide/index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: 'Introduction'
title: Introduction
weight: 5
---
## AsyncAPI Style Guide
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Links
description: This style guide gives advice on creating effective text, internal, external, and asset links in AsyncAPI content.
weight: 130
weight: 120
---


Expand Down
2 changes: 1 addition & 1 deletion docs/011-styleguide/numbers.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Numbers
description: This style guide provides guidelines for writing numbers as words, number ranges, and so on in AsyncAPI documentation.
weight: 90
weight: 80
---

# Numbers Guidelines
Expand Down
2 changes: 1 addition & 1 deletion docs/011-styleguide/punctuation.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Punctuation style guide
description: The style guide outlines the guidelines for using punctuation in the documentation.
weight: 100
weight: 90
---

# Punctuation
Expand Down
2 changes: 1 addition & 1 deletion docs/011-styleguide/seo-guide.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: SEO
description: This guide gives advice on how to implement SEO when creating tutorials and other forms of content for AsyncAPI.
weight: 140
weight: 130
---

## What is SEO?
Expand Down
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
---
title: Version Control
description: A guide to using version control in AsyncAPI
weight: 170
weight: 150
---
## Version Control

At AsyncAPI, version control is used to keep track of what has changed, who made the change, and why. This helps maintainers, contributors, and users understand how the documentation has evolved, making it easier for everyone to contribute.
At AsyncAPI, version control is used to keep track of what has changed, who made the change, and why. This helps maintainers, contributors, and users understand how the documentation has evolved, making it easier for everyone to contribute.

### How Documentation Versions Work

Expand Down
2 changes: 1 addition & 1 deletion docs/011-styleguide/voice-and-tone.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Voice and Tone"
description: Guidelines for voice and tone in the documentation.
weight: 70
weight: 60
---

## Introduction
Expand Down
4 changes: 4 additions & 0 deletions docs/020-governance-and-policies/CHARTER.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
---
title: CHARTER
weight: 10
---

<p align="center"><strong>Technical Charter (the “Charter”)</strong></p>
<p align="center">
for</br>
Expand Down
Loading
Loading