From 0ab1f3e75d2f03a05189a09b619768ad754abc38 Mon Sep 17 00:00:00 2001 From: HassanBahati Date: Sun, 3 Dec 2023 12:18:38 +0000 Subject: [PATCH 01/22] docs: add tools and processes section --- docs/tools-and-processes/_section.md | 4 ++++ 1 file changed, 4 insertions(+) create mode 100644 docs/tools-and-processes/_section.md diff --git a/docs/tools-and-processes/_section.md b/docs/tools-and-processes/_section.md new file mode 100644 index 000000000..b565255ef --- /dev/null +++ b/docs/tools-and-processes/_section.md @@ -0,0 +1,4 @@ +--- +title: Tools and Processes +weight: 10 +--- \ No newline at end of file From 070bb43dd03958dd240d656180fd58eaa7893cf1 Mon Sep 17 00:00:00 2001 From: HassanBahati Date: Sun, 3 Dec 2023 12:48:47 +0000 Subject: [PATCH 02/22] docs: add tools for tw section --- docs/tools-and-processes/tools.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) create mode 100644 docs/tools-and-processes/tools.md diff --git a/docs/tools-and-processes/tools.md b/docs/tools-and-processes/tools.md new file mode 100644 index 000000000..db4cfcd66 --- /dev/null +++ b/docs/tools-and-processes/tools.md @@ -0,0 +1,23 @@ +--- +title: Tools for Technical Writers +weight: 10 +--- + +## AsyncAPI Tools for Technical Writers + +To effectively contribute to the AsyncAPI project documentation, you will need the following +range of tools to author technical documentation; + +1. Hardware and Internet +- A laptop or desktop computer capable of running the tools necessary for contributing to the project. +- Stable internet access to clone the project repository, submit contributions and stay updated on project changes. + +2. Software and Platforms +- [GitHub](https://github.com) account: All our project's source code and documentation are hosted on GitHub. You'll need an account to create issues, fork the repository, submit pull requests, etc. If you're new to GitHub, familiarize yourself with its [basic functionalities](https://docs.github.com/en/get-started) and workflows. + +3. Authoring and publishing tools +- Code editor: Any text editor or IDE capable of handling Markdown files should suffice (we recommend [VS Code](https://code.visualstudio.com), but you can choose). +- Managing docs (wiki, source control, content management system) + - [Git](https://git-scm.com), [GitHub](https://github.com) + +Remember, these are just the basic requirements. Additional tools or software may be required depending on the complexity and specific tasks. Always refer to the specific documentation guidelines or ask project maintainers for clarification. \ No newline at end of file From a7597d4cb660af9e23ead5b73fe33d1400456e3b Mon Sep 17 00:00:00 2001 From: HassanBahati Date: Sun, 3 Dec 2023 12:58:53 +0000 Subject: [PATCH 03/22] docs: add section on setting up local environment --- docs/tools-and-processes/setup.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) create mode 100644 docs/tools-and-processes/setup.md diff --git a/docs/tools-and-processes/setup.md b/docs/tools-and-processes/setup.md new file mode 100644 index 000000000..3250b62d6 --- /dev/null +++ b/docs/tools-and-processes/setup.md @@ -0,0 +1,16 @@ +--- +title: Setup your AsyncAPI local environment +weight: 10 +--- + +## Setup your AsyncAPI local environment + +Take the following steps to set up your local environment; + +1. Fork the Repo for the project you are interested in. + +2. Clone the repo to your local machine. + +3. Open the project in [VS Code](https://code.visualstudio.com). + +4. Start editing. From b7bdf1a79ed2e6257133978c2b1cb6c53f799bc0 Mon Sep 17 00:00:00 2001 From: HassanBahati Date: Sun, 3 Dec 2023 13:13:20 +0000 Subject: [PATCH 04/22] docs: add contribute to docs section --- docs/tools-and-processes/contribute.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) create mode 100644 docs/tools-and-processes/contribute.md diff --git a/docs/tools-and-processes/contribute.md b/docs/tools-and-processes/contribute.md new file mode 100644 index 000000000..baa85cd1d --- /dev/null +++ b/docs/tools-and-processes/contribute.md @@ -0,0 +1,17 @@ +--- +title: Contribute to Docs +weight: 10 +--- + +## Contribute to Docs + +These are some ways to get your first task: + +1. Work on existing docs’ issues: Look for issues with the ‘docs, ’ ‘documentation,’ ‘area/docs,’ and ‘good-first-issue’ tags on the [Docs Project board](https://github.com/orgs/asyncapi/projects/12). + +2. Update current docs: Surf the existing documentation, look for typos, grammar, and errors, create an issue, and send a Pull Request. + +3. Propose new docs: If you have any ideas or suggestions for necessary documentation, create an issue and ask for help to work on the task. + +4. Connect with a docs mentor: Send a DM via [Slack](https://www.asyncapi.com/slack-invite) to Alejandra Quetzalli to get assigned to a task. + From c2057c9f301ed05064371b19c6df9080ad43e3da Mon Sep 17 00:00:00 2001 From: HassanBahati Date: Sun, 3 Dec 2023 14:42:18 +0000 Subject: [PATCH 05/22] docs: add highlighting for issue tags under contribute to docs --- docs/tools-and-processes/contribute.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/tools-and-processes/contribute.md b/docs/tools-and-processes/contribute.md index baa85cd1d..44599f70d 100644 --- a/docs/tools-and-processes/contribute.md +++ b/docs/tools-and-processes/contribute.md @@ -7,7 +7,7 @@ weight: 10 These are some ways to get your first task: -1. Work on existing docs’ issues: Look for issues with the ‘docs, ’ ‘documentation,’ ‘area/docs,’ and ‘good-first-issue’ tags on the [Docs Project board](https://github.com/orgs/asyncapi/projects/12). +1. Work on existing docs issues: Look for issues with the `docs`, `documentation`, `area/docs`, and `good-first-issue` tags on the [Docs Project board](https://github.com/orgs/asyncapi/projects/12). 2. Update current docs: Surf the existing documentation, look for typos, grammar, and errors, create an issue, and send a Pull Request. From 55047dc01c78b9e85efdbd0b2bd80552e638a71e Mon Sep 17 00:00:00 2001 From: HassanBahati Date: Sun, 3 Dec 2023 14:52:19 +0000 Subject: [PATCH 06/22] docs: highlight section headings in tools and contributing docs --- docs/tools-and-processes/contribute.md | 2 +- docs/tools-and-processes/tools.md | 6 +++--- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/tools-and-processes/contribute.md b/docs/tools-and-processes/contribute.md index 44599f70d..7d1444e38 100644 --- a/docs/tools-and-processes/contribute.md +++ b/docs/tools-and-processes/contribute.md @@ -9,7 +9,7 @@ These are some ways to get your first task: 1. Work on existing docs issues: Look for issues with the `docs`, `documentation`, `area/docs`, and `good-first-issue` tags on the [Docs Project board](https://github.com/orgs/asyncapi/projects/12). -2. Update current docs: Surf the existing documentation, look for typos, grammar, and errors, create an issue, and send a Pull Request. +2. Update current docs: Surf the existing documentation, look for `typos`, `grammar`, `errors`, create an issue, and send a Pull Request. 3. Propose new docs: If you have any ideas or suggestions for necessary documentation, create an issue and ask for help to work on the task. diff --git a/docs/tools-and-processes/tools.md b/docs/tools-and-processes/tools.md index db4cfcd66..378d64809 100644 --- a/docs/tools-and-processes/tools.md +++ b/docs/tools-and-processes/tools.md @@ -8,14 +8,14 @@ weight: 10 To effectively contribute to the AsyncAPI project documentation, you will need the following range of tools to author technical documentation; -1. Hardware and Internet +#### 1. Hardware and Internet - A laptop or desktop computer capable of running the tools necessary for contributing to the project. - Stable internet access to clone the project repository, submit contributions and stay updated on project changes. -2. Software and Platforms +#### 2. Software and Platforms - [GitHub](https://github.com) account: All our project's source code and documentation are hosted on GitHub. You'll need an account to create issues, fork the repository, submit pull requests, etc. If you're new to GitHub, familiarize yourself with its [basic functionalities](https://docs.github.com/en/get-started) and workflows. -3. Authoring and publishing tools +#### 3. Authoring and publishing tools - Code editor: Any text editor or IDE capable of handling Markdown files should suffice (we recommend [VS Code](https://code.visualstudio.com), but you can choose). - Managing docs (wiki, source control, content management system) - [Git](https://git-scm.com), [GitHub](https://github.com) From f8f391819a7bfe111cc4e4544d03268df5893924 Mon Sep 17 00:00:00 2001 From: Quetzalli Date: Thu, 1 Feb 2024 16:40:48 -0800 Subject: [PATCH 07/22] remove my name from guide --- docs/tools-and-processes/contribute.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/tools-and-processes/contribute.md b/docs/tools-and-processes/contribute.md index 7d1444e38..0cd842948 100644 --- a/docs/tools-and-processes/contribute.md +++ b/docs/tools-and-processes/contribute.md @@ -13,5 +13,5 @@ These are some ways to get your first task: 3. Propose new docs: If you have any ideas or suggestions for necessary documentation, create an issue and ask for help to work on the task. -4. Connect with a docs mentor: Send a DM via [Slack](https://www.asyncapi.com/slack-invite) to Alejandra Quetzalli to get assigned to a task. +4. Connect with a docs mentor: Ask for a `good-first-issue` in the `#13_docs` channel of the [AsyncAPI Slack](https://www.asyncapi.com/slack-invite) workspace. From 19a24418d98d7551819bc9a9372d1b056286cd9f Mon Sep 17 00:00:00 2001 From: Quetzalli Date: Thu, 1 Feb 2024 16:46:55 -0800 Subject: [PATCH 08/22] Delete docs/tools-and-processes/_section.md --- docs/tools-and-processes/_section.md | 4 ---- 1 file changed, 4 deletions(-) delete mode 100644 docs/tools-and-processes/_section.md diff --git a/docs/tools-and-processes/_section.md b/docs/tools-and-processes/_section.md deleted file mode 100644 index b565255ef..000000000 --- a/docs/tools-and-processes/_section.md +++ /dev/null @@ -1,4 +0,0 @@ ---- -title: Tools and Processes -weight: 10 ---- \ No newline at end of file From dde5355979149e4c79ce569b8f5527a8399b0167 Mon Sep 17 00:00:00 2001 From: Quetzalli Date: Thu, 1 Feb 2024 16:48:02 -0800 Subject: [PATCH 09/22] Update and rename contribute.md to contribute-to-docs.md --- .../{contribute.md => contribute-to-docs.md} | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) rename docs/tools-and-processes/{contribute.md => contribute-to-docs.md} (93%) diff --git a/docs/tools-and-processes/contribute.md b/docs/tools-and-processes/contribute-to-docs.md similarity index 93% rename from docs/tools-and-processes/contribute.md rename to docs/tools-and-processes/contribute-to-docs.md index 0cd842948..81e249b17 100644 --- a/docs/tools-and-processes/contribute.md +++ b/docs/tools-and-processes/contribute-to-docs.md @@ -1,9 +1,9 @@ --- -title: Contribute to Docs +title: Contribute to docs weight: 10 --- -## Contribute to Docs +## Contribute to docs These are some ways to get your first task: From 0e1bd6645b8b860a265443ace64060d6ff10d8b2 Mon Sep 17 00:00:00 2001 From: Quetzalli Date: Thu, 1 Feb 2024 16:49:20 -0800 Subject: [PATCH 10/22] Rename setup.md to setup-local-environment.md --- docs/tools-and-processes/{setup.md => setup-local-environment.md} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename docs/tools-and-processes/{setup.md => setup-local-environment.md} (100%) diff --git a/docs/tools-and-processes/setup.md b/docs/tools-and-processes/setup-local-environment.md similarity index 100% rename from docs/tools-and-processes/setup.md rename to docs/tools-and-processes/setup-local-environment.md From d1d4a2c9d106bb132b4ae9ae3487838933a66d42 Mon Sep 17 00:00:00 2001 From: Quetzalli Date: Thu, 1 Feb 2024 16:50:39 -0800 Subject: [PATCH 11/22] Update and rename tools.md to technical-writer-tools.md --- .../{tools.md => technical-writer-tools.md} | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) rename docs/tools-and-processes/{tools.md => technical-writer-tools.md} (93%) diff --git a/docs/tools-and-processes/tools.md b/docs/tools-and-processes/technical-writer-tools.md similarity index 93% rename from docs/tools-and-processes/tools.md rename to docs/tools-and-processes/technical-writer-tools.md index 378d64809..272dcbbef 100644 --- a/docs/tools-and-processes/tools.md +++ b/docs/tools-and-processes/technical-writer-tools.md @@ -3,7 +3,7 @@ title: Tools for Technical Writers weight: 10 --- -## AsyncAPI Tools for Technical Writers +## Tools for Technical Writers To effectively contribute to the AsyncAPI project documentation, you will need the following range of tools to author technical documentation; @@ -20,4 +20,4 @@ range of tools to author technical documentation; - Managing docs (wiki, source control, content management system) - [Git](https://git-scm.com), [GitHub](https://github.com) -Remember, these are just the basic requirements. Additional tools or software may be required depending on the complexity and specific tasks. Always refer to the specific documentation guidelines or ask project maintainers for clarification. \ No newline at end of file +Remember, these are just the basic requirements. Additional tools or software may be required depending on the complexity and specific tasks. Always refer to the specific documentation guidelines or ask project maintainers for clarification. From b557d9730d72c894b96c5ff969f8949c415e189f Mon Sep 17 00:00:00 2001 From: Quetzalli <19964402+alequetzalli@users.noreply.github.com> Date: Mon, 25 Mar 2024 15:48:37 -0700 Subject: [PATCH 12/22] Rename technical-writer-tools.md to technical-writer-tools.md --- .../technical-writer-tools.md | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename docs/{tools-and-processes => onboarding-guide}/technical-writer-tools.md (100%) diff --git a/docs/tools-and-processes/technical-writer-tools.md b/docs/onboarding-guide/technical-writer-tools.md similarity index 100% rename from docs/tools-and-processes/technical-writer-tools.md rename to docs/onboarding-guide/technical-writer-tools.md From 067d6e4e124c9c6c5dd945b0300e0fa5ffc6ea63 Mon Sep 17 00:00:00 2001 From: Quetzalli <19964402+alequetzalli@users.noreply.github.com> Date: Mon, 25 Mar 2024 15:50:40 -0700 Subject: [PATCH 13/22] Rename contribute-to-docs.md to contribute-to-docs.md --- .../contribute-to-docs.md | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename docs/{tools-and-processes => onboarding-guide}/contribute-to-docs.md (100%) diff --git a/docs/tools-and-processes/contribute-to-docs.md b/docs/onboarding-guide/contribute-to-docs.md similarity index 100% rename from docs/tools-and-processes/contribute-to-docs.md rename to docs/onboarding-guide/contribute-to-docs.md From 424ef724c2b5ba64803c00fa14ce874b898ed67d Mon Sep 17 00:00:00 2001 From: Quetzalli <19964402+alequetzalli@users.noreply.github.com> Date: Mon, 25 Mar 2024 15:52:10 -0700 Subject: [PATCH 14/22] Delete docs/tools-and-processes/setup-local-environment.md --- .../setup-local-environment.md | 16 ---------------- 1 file changed, 16 deletions(-) delete mode 100644 docs/tools-and-processes/setup-local-environment.md diff --git a/docs/tools-and-processes/setup-local-environment.md b/docs/tools-and-processes/setup-local-environment.md deleted file mode 100644 index 3250b62d6..000000000 --- a/docs/tools-and-processes/setup-local-environment.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -title: Setup your AsyncAPI local environment -weight: 10 ---- - -## Setup your AsyncAPI local environment - -Take the following steps to set up your local environment; - -1. Fork the Repo for the project you are interested in. - -2. Clone the repo to your local machine. - -3. Open the project in [VS Code](https://code.visualstudio.com). - -4. Start editing. From c2ab80ce7057160fd0528bac2e42eeef0bb4b676 Mon Sep 17 00:00:00 2001 From: Quetzalli <19964402+alequetzalli@users.noreply.github.com> Date: Mon, 25 Mar 2024 15:56:49 -0700 Subject: [PATCH 15/22] Update and rename technical-writer-tools.md to tools-and-setup.md --- .../technical-writer-tools.md | 23 -------- docs/onboarding-guide/tools-and-setup.md | 57 +++++++++++++++++++ 2 files changed, 57 insertions(+), 23 deletions(-) delete mode 100644 docs/onboarding-guide/technical-writer-tools.md create mode 100644 docs/onboarding-guide/tools-and-setup.md diff --git a/docs/onboarding-guide/technical-writer-tools.md b/docs/onboarding-guide/technical-writer-tools.md deleted file mode 100644 index 272dcbbef..000000000 --- a/docs/onboarding-guide/technical-writer-tools.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: Tools for Technical Writers -weight: 10 ---- - -## Tools for Technical Writers - -To effectively contribute to the AsyncAPI project documentation, you will need the following -range of tools to author technical documentation; - -#### 1. Hardware and Internet -- A laptop or desktop computer capable of running the tools necessary for contributing to the project. -- Stable internet access to clone the project repository, submit contributions and stay updated on project changes. - -#### 2. Software and Platforms -- [GitHub](https://github.com) account: All our project's source code and documentation are hosted on GitHub. You'll need an account to create issues, fork the repository, submit pull requests, etc. If you're new to GitHub, familiarize yourself with its [basic functionalities](https://docs.github.com/en/get-started) and workflows. - -#### 3. Authoring and publishing tools -- Code editor: Any text editor or IDE capable of handling Markdown files should suffice (we recommend [VS Code](https://code.visualstudio.com), but you can choose). -- Managing docs (wiki, source control, content management system) - - [Git](https://git-scm.com), [GitHub](https://github.com) - -Remember, these are just the basic requirements. Additional tools or software may be required depending on the complexity and specific tasks. Always refer to the specific documentation guidelines or ask project maintainers for clarification. diff --git a/docs/onboarding-guide/tools-and-setup.md b/docs/onboarding-guide/tools-and-setup.md new file mode 100644 index 000000000..dd1a6f172 --- /dev/null +++ b/docs/onboarding-guide/tools-and-setup.md @@ -0,0 +1,57 @@ +--- +title: Tools and setup +weight: 60 +--- + +## Tools and setup for technical writers + +To effectively contribute to the AsyncAPI project documentation, you will need the following range of tools and local setup to author technical documentation. + +### Hardware and Internet +- A laptop or desktop computer capable of running the tools necessary for contributing to the project. +- Stable internet access to clone the project repository, submit contributions and stay updated on project changes. + +### Software and Platforms +- [GitHub](https://github.com) account: All our project's source code and documentation are hosted on GitHub. You'll need an account to create issues, fork the repository, submit pull requests, etc. If you're new to GitHub, familiarize yourself with its [basic functionalities](https://docs.github.com/en/get-started) and workflows. + +### Authoring and publishing tools +- Code editor: Any text editor or IDE capable of handling Markdown files should suffice (we recommend [VS Code](https://code.visualstudio.com), but you can choose). +- Managing docs (wiki, source control, content management system) + - [Git](https://git-scm.com), [GitHub](https://github.com) + +Remember, these are just the basic requirements. Depending on the complexity and specific tasks, additional tools or software may be required. Always refer to the specific documentation guidelines or ask project maintainers for clarification. + + +## Setup your AsyncAPI local environment +1. Fork the repository by clicking on 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). + + From ee2f57b8eafae9e397d0244607c1b350c07cfb10 Mon Sep 17 00:00:00 2001 From: Quetzalli <19964402+alequetzalli@users.noreply.github.com> Date: Mon, 25 Mar 2024 16:05:17 -0700 Subject: [PATCH 16/22] Update contribute-to-docs.md --- docs/onboarding-guide/contribute-to-docs.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/onboarding-guide/contribute-to-docs.md b/docs/onboarding-guide/contribute-to-docs.md index 81e249b17..cee833276 100644 --- a/docs/onboarding-guide/contribute-to-docs.md +++ b/docs/onboarding-guide/contribute-to-docs.md @@ -1,17 +1,17 @@ --- title: Contribute to docs -weight: 10 +weight: 70 --- ## Contribute to docs -These are some ways to get your first task: +These are several ways to get your first docs task: -1. Work on existing docs issues: Look for issues with the `docs`, `documentation`, `area/docs`, and `good-first-issue` tags on the [Docs Project board](https://github.com/orgs/asyncapi/projects/12). +1. Work on existing docs issues: Look for issues with the `docs` or `docs bug` and `good-first-issue` labels on the [Docs Project board](https://github.com/orgs/asyncapi/projects/12). -2. Update current docs: Surf the existing documentation, look for `typos`, `grammar`, `errors`, create an issue, and send a Pull Request. +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 an issue and ask for help to work on the task. +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. -4. Connect with a docs mentor: Ask for a `good-first-issue` in the `#13_docs` channel of the [AsyncAPI Slack](https://www.asyncapi.com/slack-invite) workspace. +4. 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. From c53469f719e55e0db12d3bf1d33e4708f6378e77 Mon Sep 17 00:00:00 2001 From: Quetzalli <19964402+alequetzalli@users.noreply.github.com> Date: Mon, 25 Mar 2024 16:07:35 -0700 Subject: [PATCH 17/22] Update contribute-to-docs.md --- docs/onboarding-guide/contribute-to-docs.md | 13 +++++-------- 1 file changed, 5 insertions(+), 8 deletions(-) diff --git a/docs/onboarding-guide/contribute-to-docs.md b/docs/onboarding-guide/contribute-to-docs.md index cee833276..72cfbde6d 100644 --- a/docs/onboarding-guide/contribute-to-docs.md +++ b/docs/onboarding-guide/contribute-to-docs.md @@ -5,13 +5,10 @@ weight: 70 ## Contribute to docs -These are several ways to get your first docs task: +There are several ways to request your first AsyncAPI docs task: -1. Work on existing docs issues: Look for issues with the `docs` or `docs bug` and `good-first-issue` labels on the [Docs Project board](https://github.com/orgs/asyncapi/projects/12). - -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. - -4. 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. +1. **Work on existing docs issues:** Look for issues with the `docs` or `docs bug` and `good-first-issue` labels on the [Docs Project board](https://github.com/orgs/asyncapi/projects/12). +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. +4. **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. From 0d187dd2934fcbcdb841a7590be98b2fe7078b6f Mon Sep 17 00:00:00 2001 From: Quetzalli <19964402+alequetzalli@users.noreply.github.com> Date: Mon, 25 Mar 2024 16:08:52 -0700 Subject: [PATCH 18/22] Update tools-and-setup.md --- docs/onboarding-guide/tools-and-setup.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/onboarding-guide/tools-and-setup.md b/docs/onboarding-guide/tools-and-setup.md index dd1a6f172..0bd3b295a 100644 --- a/docs/onboarding-guide/tools-and-setup.md +++ b/docs/onboarding-guide/tools-and-setup.md @@ -3,9 +3,9 @@ title: Tools and setup weight: 60 --- -## Tools and setup for technical writers +## Tools for technical writers -To effectively contribute to the AsyncAPI project documentation, you will need the following range of tools and local setup to author technical documentation. +To effectively contribute to the AsyncAPI project documentation, you will need the following range of tools to author technical documentation. ### Hardware and Internet - A laptop or desktop computer capable of running the tools necessary for contributing to the project. From afcdea9917a5fab4f20232f48bec99568476de46 Mon Sep 17 00:00:00 2001 From: Quetzalli <19964402+alequetzalli@users.noreply.github.com> Date: Mon, 25 Mar 2024 16:18:45 -0700 Subject: [PATCH 19/22] Update contribute-to-docs.md --- docs/onboarding-guide/contribute-to-docs.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/onboarding-guide/contribute-to-docs.md b/docs/onboarding-guide/contribute-to-docs.md index 72cfbde6d..6b73c1ec3 100644 --- a/docs/onboarding-guide/contribute-to-docs.md +++ b/docs/onboarding-guide/contribute-to-docs.md @@ -7,8 +7,8 @@ weight: 70 There are several ways to request your first AsyncAPI docs task: -1. **Work on existing docs issues:** Look for issues with the `docs` or `docs bug` and `good-first-issue` labels on the [Docs Project board](https://github.com/orgs/asyncapi/projects/12). +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. -4. **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. + From d263b44d3911bd1b1f6977684d76a1f1a2add4df Mon Sep 17 00:00:00 2001 From: Quetzalli <19964402+alequetzalli@users.noreply.github.com> Date: Mon, 25 Mar 2024 16:28:58 -0700 Subject: [PATCH 20/22] Update tools-and-setup.md --- docs/onboarding-guide/tools-and-setup.md | 24 +++++++----------------- 1 file changed, 7 insertions(+), 17 deletions(-) diff --git a/docs/onboarding-guide/tools-and-setup.md b/docs/onboarding-guide/tools-and-setup.md index 0bd3b295a..4b6326a1b 100644 --- a/docs/onboarding-guide/tools-and-setup.md +++ b/docs/onboarding-guide/tools-and-setup.md @@ -5,25 +5,17 @@ weight: 60 ## Tools for technical writers -To effectively contribute to the AsyncAPI project documentation, you will need the following range of tools to author technical documentation. +Technical writer contributors need the following tools to contribute to AsyncAPI documentation effectively: -### Hardware and Internet -- A laptop or desktop computer capable of running the tools necessary for contributing to the project. -- Stable internet access to clone the project repository, submit contributions and stay updated on project changes. - -### Software and Platforms -- [GitHub](https://github.com) account: All our project's source code and documentation are hosted on GitHub. You'll need an account to create issues, fork the repository, submit pull requests, etc. If you're new to GitHub, familiarize yourself with its [basic functionalities](https://docs.github.com/en/get-started) and workflows. - -### Authoring and publishing tools -- Code editor: Any text editor or IDE capable of handling Markdown files should suffice (we recommend [VS Code](https://code.visualstudio.com), but you can choose). -- Managing docs (wiki, source control, content management system) - - [Git](https://git-scm.com), [GitHub](https://github.com) - -Remember, these are just the basic requirements. Depending on the complexity and specific tasks, additional tools or software may be required. Always refer to the specific documentation guidelines or ask project maintainers for clarification. +- 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). +- Code editor: Any text editor or IDE, such as [VS Code](https://code.visualstudio.com), capable of handling Markdown files. +- Basic understanding of [Git](https://git-scm.com). ## Setup your AsyncAPI local environment -1. Fork the repository by clicking on the `Fork` option on the top right of the main repository. +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. @@ -53,5 +45,3 @@ Remember, these are just the basic requirements. Depending on the complexity and ``` 7. Access the live development server at [localhost:3000](http://localhost:3000). - - From 41832498f2179fe9d25d5bf7da08c4fc7fe0d175 Mon Sep 17 00:00:00 2001 From: Quetzalli <19964402+alequetzalli@users.noreply.github.com> Date: Mon, 25 Mar 2024 16:31:53 -0700 Subject: [PATCH 21/22] spacing fix --- docs/onboarding-guide/contribute-to-docs.md | 2 -- docs/onboarding-guide/tools-and-setup.md | 1 - 2 files changed, 3 deletions(-) diff --git a/docs/onboarding-guide/contribute-to-docs.md b/docs/onboarding-guide/contribute-to-docs.md index 6b73c1ec3..092fd477e 100644 --- a/docs/onboarding-guide/contribute-to-docs.md +++ b/docs/onboarding-guide/contribute-to-docs.md @@ -10,5 +10,3 @@ 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 index 4b6326a1b..365c2b33b 100644 --- a/docs/onboarding-guide/tools-and-setup.md +++ b/docs/onboarding-guide/tools-and-setup.md @@ -13,7 +13,6 @@ Technical writer contributors need the following tools to contribute to AsyncAPI - Code editor: Any text editor or IDE, such as [VS Code](https://code.visualstudio.com), capable of handling Markdown files. - Basic understanding of [Git](https://git-scm.com). - ## Setup your AsyncAPI local environment 1. Fork the repository by clicking the `Fork` option on the top right of the main repository. From f473674788bfa2367e74ecad7004c1da68fdf3a3 Mon Sep 17 00:00:00 2001 From: Quetzalli <19964402+alequetzalli@users.noreply.github.com> Date: Mon, 25 Mar 2024 16:35:35 -0700 Subject: [PATCH 22/22] Update tools-and-setup.md --- docs/onboarding-guide/tools-and-setup.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/onboarding-guide/tools-and-setup.md b/docs/onboarding-guide/tools-and-setup.md index 365c2b33b..24bc37454 100644 --- a/docs/onboarding-guide/tools-and-setup.md +++ b/docs/onboarding-guide/tools-and-setup.md @@ -10,8 +10,8 @@ Technical writer contributors need the following tools to contribute to AsyncAPI - 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). -- Code editor: Any text editor or IDE, such as [VS Code](https://code.visualstudio.com), capable of handling Markdown files. -- Basic understanding of [Git](https://git-scm.com). +- 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.