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 8 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
4 changes: 4 additions & 0 deletions docs/tools-and-processes/_section.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
title: Tools and Processes
weight: 10
---
17 changes: 17 additions & 0 deletions docs/tools-and-processes/contribute.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
title: Contribute to Docs
weight: 10
---

## Contribute to Docs

These are some ways to get your first task:

1. <b>Work on existing docs issues</b>: 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. <b>Update current docs</b>: Surf the existing documentation, look for `typos`, `grammar`, `errors`, create an issue, and send a Pull Request.

3. <b>Propose new docs</b>: If you have any ideas or suggestions for necessary documentation, create an issue and ask for help to work on the task.

4. <b>Connect with a docs mentor</b>: Send a DM via [Slack](https://www.asyncapi.com/slack-invite) to Alejandra Quetzalli to get assigned to a task.
quetzalliwrites marked this conversation as resolved.
Show resolved Hide resolved
quetzalliwrites marked this conversation as resolved.
Show resolved Hide resolved

16 changes: 16 additions & 0 deletions docs/tools-and-processes/setup.md
Original file line number Diff line number Diff line change
@@ -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.
23 changes: 23 additions & 0 deletions docs/tools-and-processes/tools.md
Original file line number Diff line number Diff line change
@@ -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.