From e55f4bfe36b1981fc0914f59676ecb9e3b666886 Mon Sep 17 00:00:00 2001 From: Hassan Bahati <65954740+HassanBahati@users.noreply.github.com> Date: Tue, 26 Mar 2024 02:45:43 +0300 Subject: [PATCH] docs: add tools and processes docs (#977) Co-authored-by: Quetzalli <19964402+alequetzalli@users.noreply.github.com>%0ACo-authored-by: Quetzalli %0ACo-authored-by: Quetzalli --- docs/onboarding-guide/contribute-to-docs.md | 12 ++++++ docs/onboarding-guide/tools-and-setup.md | 46 +++++++++++++++++++++ 2 files changed, 58 insertions(+) create mode 100644 docs/onboarding-guide/contribute-to-docs.md create mode 100644 docs/onboarding-guide/tools-and-setup.md diff --git a/docs/onboarding-guide/contribute-to-docs.md b/docs/onboarding-guide/contribute-to-docs.md new file mode 100644 index 000000000..092fd477e --- /dev/null +++ b/docs/onboarding-guide/contribute-to-docs.md @@ -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. diff --git a/docs/onboarding-guide/tools-and-setup.md b/docs/onboarding-guide/tools-and-setup.md new file mode 100644 index 000000000..24bc37454 --- /dev/null +++ b/docs/onboarding-guide/tools-and-setup.md @@ -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 ``. + 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//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).