|
1 | 1 | ---
|
2 |
| -title: Tools and setup |
| 2 | +title: Recommended tools and setup |
3 | 3 | weight: 60
|
4 | 4 | ---
|
5 | 5 |
|
6 |
| -## Tools for technical writers |
| 6 | +These are the recommended tools for contributors, as well as instructions for setting up the AsyncAPI website in your local environment. |
7 | 7 |
|
8 |
| -Technical writer contributors need the following tools to contribute to AsyncAPI documentation effectively: |
9 |
| - |
10 |
| -- A laptop or desktop computer capable of running the tools necessary to contribute to the project. |
11 |
| -- Stable internet access to clone the project repository, submit contributions, and stay updated on project changes. |
12 |
| -- 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). |
13 |
| -- A code editor, such as [VS Code](https://code.visualstudio.com), capable of handling Markdown files. |
14 |
| -- [Git](https://git-scm.com), a version control system. |
| 8 | +## Recommended Tools |
| 9 | +- [Git](https://git-scm.com) to work with the organization's repositories. |
| 10 | +- [A GitHub account](https://github.com) to fork AsyncAPI repositories, create issues, submit pull requests, and participate in discussions. If you're new to GitHub, familiarize yourself with [basic GitHub functionalities and workflows](https://docs.github.com/en/get-started). |
| 11 | +- A code editor, such as [VS Code](https://code.visualstudio.com) to work on your changes. |
| 12 | +- Command-line terminal, such as the one included in your OS, or the terminal integrated in your code editor or IDE, to run commands. |
| 13 | +- [Node.js and npm](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm) to build and run the website locally. |
| 14 | +- A web browser, such as Google Chrome, Firefox or Microsoft Edge to preview your changes. |
| 15 | +- To preview minor changes in Markdown documents without spinning up a dev server, you can use out-of-the-box capabilities of your code editor, or install the corresponding extension. For more information, please consult your code editor's documentation. |
15 | 16 |
|
16 | 17 | ## Setup your AsyncAPI local environment
|
17 | 18 | 1. Fork the repository by clicking the `Fork` option on the top right of the main repository.
|
|
0 commit comments