Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add tools and processes docs #977

Merged
merged 25 commits into from
Mar 25, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
25 commits
Select commit Hold shift + click to select a range
d550379
Merge branch 'master' into docs-tools-processes
HassanBahati Dec 3, 2023
0ab1f3e
docs: add tools and processes section
HassanBahati Dec 3, 2023
070bb43
docs: add tools for tw section
HassanBahati Dec 3, 2023
e613090
Merge branch 'docs-tools-processes' of https://github.com/HassanBahat…
HassanBahati Dec 3, 2023
a7597d4
docs: add section on setting up local environment
HassanBahati Dec 3, 2023
b7bdf1a
docs: add contribute to docs section
HassanBahati Dec 3, 2023
c2057c9
docs: add highlighting for issue tags under contribute to docs
HassanBahati Dec 3, 2023
55047dc
docs: highlight section headings in tools and contributing docs
HassanBahati Dec 3, 2023
f8f3918
remove my name from guide
quetzalliwrites Feb 2, 2024
19a2441
Delete docs/tools-and-processes/_section.md
quetzalliwrites Feb 2, 2024
dde5355
Update and rename contribute.md to contribute-to-docs.md
quetzalliwrites Feb 2, 2024
0e1bd66
Rename setup.md to setup-local-environment.md
quetzalliwrites Feb 2, 2024
d1d4a2c
Update and rename tools.md to technical-writer-tools.md
quetzalliwrites Feb 2, 2024
b557d97
Rename technical-writer-tools.md to technical-writer-tools.md
quetzalliwrites Mar 25, 2024
067d6e4
Rename contribute-to-docs.md to contribute-to-docs.md
quetzalliwrites Mar 25, 2024
424ef72
Delete docs/tools-and-processes/setup-local-environment.md
quetzalliwrites Mar 25, 2024
c2ab80c
Update and rename technical-writer-tools.md to tools-and-setup.md
quetzalliwrites Mar 25, 2024
ee2f57b
Update contribute-to-docs.md
quetzalliwrites Mar 25, 2024
c53469f
Update contribute-to-docs.md
quetzalliwrites Mar 25, 2024
0d187dd
Update tools-and-setup.md
quetzalliwrites Mar 25, 2024
afcdea9
Update contribute-to-docs.md
quetzalliwrites Mar 25, 2024
d263b44
Update tools-and-setup.md
quetzalliwrites Mar 25, 2024
4183249
spacing fix
quetzalliwrites Mar 25, 2024
f473674
Update tools-and-setup.md
quetzalliwrites Mar 25, 2024
c1fe40f
Merge branch 'master' into docs-tools-processes
quetzalliwrites Mar 25, 2024
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
12 changes: 12 additions & 0 deletions docs/onboarding-guide/contribute-to-docs.md
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.
46 changes: 46 additions & 0 deletions docs/onboarding-guide/tools-and-setup.md
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).
Loading