docs: new style guide - Version Control

[quetzalliwrites]

Let's finally get around to creating, designing, and incorporating an AsyncAPI Style Guide!

Why the need?

In tech jobs, we often focus on our technology's technical aspects, such as functionality and performance. However, the documentation for our technology is equally important to the code itself. A style guide ensures consistency and clarity, establishes a consistent voice and tone in your documentation, makes it easier for multiple writers to work together on a single doc, and helps ensure documentation is accurate and up-to-date. When all of your technical writers follow the same guidelines, it's easier for readers to find the information they need and understand how to use your product or OSS technology.

What section of the AsyncAPI Style Guide is this issue for?

• Version control: Explain how version control is incorporated for AsyncAPI because docs will consistently undergo much revision and redrafting. Understanding version control in docs helps us to track changes and identify when key decisions were made along the way.

Where should this go?

Let's create a new .md file for only the Version control section of the new AsyncAPI Style Guide.

Create the following directory and place your file there: asyncapi.com/docs/community/styleguide/version-control.md.

Extra Resources

• Write the Docs: Style Guides
• Gatsby Style Guide
• Gatsby Docs Structure & Documentation Types
• Mozilla Style Guide
• Google Style Guide
• Microsoft Style Guide

[Dule-martins]

Hello @alequetzalli
To be sure I understand your instructions, am I to create a .md file inside the community repository within a style guide folder inside the docs folder?
What I mean is this: www.github.com/asynciapi/community/docs/styleguide/version-control.md

[quetzalliwrites]

Sorry @Dule-martins I am giving this task to another contributor, so you can't pick this one up :)

[Dule-martins]

okay, @alequetzalli

[soma2000-lang]

Working on this @alequetzalli

[quetzalliwrites]

Great!!! Quick update:

I didn't mention this before because we recently merged our new Community content bucket into the docs this week... but now that we have a LIVE Community content bucket in the docs, we actually should be authoring community docs directly in the /Community repo. (We actually have similar behavior/process in place for tools and specification docs too! Tools and specification docs are actually stored in their repoes and then copies to our website repo docs.)

Please make sure to open your PR in the Community repo. 😄 We are storing our Style Guide in the Community content bucket so your directory needs to be:
asyncapi.com/docs/community/style-guide/version-control.

Remember to use a dash to separate the words style-guide and version-control.

[github-actions]

This issue has been automatically marked as stale because it has not had recent activity 😴

It will be closed in 120 days if no further activity occurs. To unstale this issue, add a comment with a detailed explanation.

There can be many reasons why some specific issue has no activity. The most probable cause is lack of time, not lack of interest. AsyncAPI Initiative is a Linux Foundation project not owned by a single for-profit company. It is a community-driven initiative ruled under open governance model.

Let us figure out together how to push this issue forward. Connect with us through one of many communication channels we established here.

Thank you for your patience ❤️