-
-
Notifications
You must be signed in to change notification settings - Fork 110
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'master' into Issue-1093
- Loading branch information
Showing
9 changed files
with
128 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
--- | ||
title: Contribute to docs | ||
weight: 70 | ||
--- | ||
|
||
## Contribute to docs | ||
|
||
There are several ways to request your first AsyncAPI docs task: | ||
|
||
1. **Connect with a docs maintainer:** Ask for a `good-first-issue` in the `#13_docs` channel of the [AsyncAPI Slack](https://www.asyncapi.com/slack-invite) workspace. | ||
2. **Update current docs:** Surf the existing documentation, look for `typos`, `grammar`, `errors`, create an issue, and submit a Pull Request. | ||
3. **Propose new docs:** If you have any ideas or suggestions for necessary documentation, [create a new docs issue](https://github.com/asyncapi/website/issues/new?labels=%F0%9F%93%91+docs&projects=&template=docs.yml&title=%5B%F0%9F%93%91+Docs%5D%3A+) and propose yourself as the assignee. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
--- | ||
title : 'Create new docs directories' | ||
weight : 80 | ||
--- | ||
|
||
### Create new docs directories | ||
Create a new docs directory (folder) via the following steps: | ||
1. Identify the content bucket under which your document falls. | ||
2. Open the project locally in your code editor of choice and navigate to the parent folder. | ||
3. Right-click on the parent folder and click "new folder". | ||
4. Give an appropriate name to the new folder. | ||
5. Add the following two files to the new folder: | ||
1. `index.md`: Used as the main content for a website's directory or specific webpage. It's named index because many web servers are configured to automatically look for an index file when accessing a directory. When you access a directory on a web server, if an `index.md` file is present, it will be displayed as the default page for that directory. | ||
2. `_section.md`: Used for reusable components or partial content within a website's structure. It defines the page's `title` and `weight`. The title defines a human-readable title, and weight controls the order in which sections (directories) are displayed. | ||
6. You can edit the index page after successfully creating these pages. | ||
|
||
```mermaid | ||
flowchart LR | ||
A[parent Folder] --> B[new Folder] | ||
B[new Folder] --> C[index.md] | ||
B[new Folder] --> D[_section.md] | ||
B[new Folder] --> E[example-doc-1.md] | ||
B[new Folder] --> F[example-doc-2.md] | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
--- | ||
title : 'Create new docs pull request' | ||
weight : 90 | ||
--- | ||
|
||
## Create a new docs pull request | ||
Create and submit a docs pull request (PR) via the following steps: | ||
|
||
- A Docsβ PR should solve one documentation problem. | ||
- If there is no current issue for the docs task you want to accomplish, please open a docs issue before creating a PR. | ||
- Use the [conventional commit style](https://github.com/asyncapi/.github/blob/master/CONTRIBUTING.md#conventional-commits) when creating PRs. Always create a docs issue or PR with the `docs:` prefix in the title. | ||
- Please check your contribution and ensure it follows the AsyncAPI style guide. | ||
- Tag other technical writers to review your document. | ||
- Tag an engineer or subject matter expert (SME) to review the technical details. | ||
- After implementing all the feedback you requested, please update your PR and wait for further feedback before it can be merged. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,46 @@ | ||
--- | ||
title: Tools and setup | ||
weight: 60 | ||
--- | ||
|
||
## Tools for technical writers | ||
|
||
Technical writer contributors need the following tools to contribute to AsyncAPI documentation effectively: | ||
|
||
- A laptop or desktop computer capable of running the tools necessary to contribute to the project. | ||
- Stable internet access to clone the project repository, submit contributions, and stay updated on project changes. | ||
- A [GitHub](https://github.com) account. AsyncAPI hosts all its project's source code and documentation on GitHub. You'll need a GitHub account to create issues, fork the repository, submit pull requests, and more. If you're new to GitHub, familiarize yourself with [basic GitHub functionalities and workflows](https://docs.github.com/en/get-started). | ||
- A code editor, such as [VS Code](https://code.visualstudio.com), capable of handling Markdown files. | ||
- [Git](https://git-scm.com), a version control system. | ||
|
||
## Setup your AsyncAPI local environment | ||
1. Fork the repository by clicking the `Fork` option on the top right of the main repository. | ||
|
||
2. Open Command Prompt on your local computer. | ||
|
||
3. Clone the forked repository by adding your GitHub username instead of `<username>`. | ||
For multiple contributions, follow the [proper configuration of a forked AsyncAPI repo](https://github.com/asyncapi/community/blob/master/git-workflow.md). | ||
|
||
```bash | ||
git clone https://github.com/<username>/website/ | ||
``` | ||
|
||
4. Navigate to the website directory. | ||
|
||
```bash | ||
cd website | ||
``` | ||
|
||
5. Install all website dependencies. | ||
|
||
```bash | ||
npm install | ||
``` | ||
|
||
6. Run the website locally. | ||
|
||
```bash | ||
npm run dev | ||
``` | ||
|
||
7. Access the live development server at [localhost:3000](http://localhost:3000). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters