From fb452171815d6325a196e5d4bd62395be7407c83 Mon Sep 17 00:00:00 2001 From: thulieblack Date: Thu, 2 Feb 2023 10:35:23 +0200 Subject: [PATCH 01/26] new_workingfolder --- pages/community/styleguide/aboutguide.md | 0 1 file changed, 0 insertions(+), 0 deletions(-) create mode 100644 pages/community/styleguide/aboutguide.md diff --git a/pages/community/styleguide/aboutguide.md b/pages/community/styleguide/aboutguide.md new file mode 100644 index 00000000000..e69de29bb2d From 11ff9b20bf6226d965228808436506d5046d9fc5 Mon Sep 17 00:00:00 2001 From: thulieblack Date: Thu, 2 Feb 2023 11:01:11 +0200 Subject: [PATCH 02/26] introduction --- pages/community/styleguide/aboutguide.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/pages/community/styleguide/aboutguide.md b/pages/community/styleguide/aboutguide.md index e69de29bb2d..6fcb2460443 100644 --- a/pages/community/styleguide/aboutguide.md +++ b/pages/community/styleguide/aboutguide.md @@ -0,0 +1,5 @@ +# AsyncAPI Style Guide + +## Introduction +Welcome to the AsyncAPI Style Guide. This page serves as a guideline to contributors on how the content/documentation should be written, structured, and formatted. + From e1fdac2374ad154ae49b8997004e53779b4eec80 Mon Sep 17 00:00:00 2001 From: thulieblack Date: Thu, 2 Feb 2023 11:38:56 +0200 Subject: [PATCH 03/26] writingguide --- pages/community/styleguide/aboutguide.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/pages/community/styleguide/aboutguide.md b/pages/community/styleguide/aboutguide.md index 6fcb2460443..264ddae6356 100644 --- a/pages/community/styleguide/aboutguide.md +++ b/pages/community/styleguide/aboutguide.md @@ -1,5 +1,9 @@ # AsyncAPI Style Guide ## Introduction -Welcome to the AsyncAPI Style Guide. This page serves as a guideline to contributors on how the content/documentation should be written, structured, and formatted. +Welcome to the AsyncAPI Style Guide. This page serves as a guideline to contributors on how to write, structure, and format content/documentation. + +These guidelines help us in maintaining language, tone, and voice throughout the website. It also makes it easier for multiple contributors to work together on a single doc while ensuring consistency, accuracy, and clarity. + +## Writing Guide From ec6fc2b8edf99285c7a1cc4a927cf2ecb79de7f2 Mon Sep 17 00:00:00 2001 From: thulieblack Date: Thu, 2 Feb 2023 11:41:34 +0200 Subject: [PATCH 04/26] update --- pages/community/styleguide/aboutguide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pages/community/styleguide/aboutguide.md b/pages/community/styleguide/aboutguide.md index 264ddae6356..25d315f1a7f 100644 --- a/pages/community/styleguide/aboutguide.md +++ b/pages/community/styleguide/aboutguide.md @@ -5,5 +5,5 @@ Welcome to the AsyncAPI Style Guide. This page serves as a guideline to contribu These guidelines help us in maintaining language, tone, and voice throughout the website. It also makes it easier for multiple contributors to work together on a single doc while ensuring consistency, accuracy, and clarity. -## Writing Guide +## Writing Style From 36935febec33b24d62408a6242edfef54df3acdc Mon Sep 17 00:00:00 2001 From: thulieblack Date: Tue, 7 Feb 2023 15:15:29 +0200 Subject: [PATCH 05/26] update --- pages/community/styleguide/aboutguide.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/pages/community/styleguide/aboutguide.md b/pages/community/styleguide/aboutguide.md index 25d315f1a7f..000eac0535f 100644 --- a/pages/community/styleguide/aboutguide.md +++ b/pages/community/styleguide/aboutguide.md @@ -6,4 +6,21 @@ Welcome to the AsyncAPI Style Guide. This page serves as a guideline to contribu These guidelines help us in maintaining language, tone, and voice throughout the website. It also makes it easier for multiple contributors to work together on a single doc while ensuring consistency, accuracy, and clarity. ## Writing Style +Below are some recommendations to consider when writing your pages. + +### Have your target audience in mind +Before you begin planning and constructing your content, it is important to know who you are writing for and how the readers will benefit from your content. +This will help you in strategizing and simplifying your writing process. + +### Research +Before creating your first draft, it is beneficial to research similar resources and use them as references. Avoid plagiarism or copying and pasting from other websites unless the content already exists on our site. + +### Follow the writing principles + + +### Prune and polish + +### Ask for feedback + + From 7a667ea7bc75b0952a615c6e5de29d4266e57ba0 Mon Sep 17 00:00:00 2001 From: thulieblack Date: Tue, 7 Feb 2023 16:09:28 +0200 Subject: [PATCH 06/26] update --- pages/community/styleguide/aboutguide.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/pages/community/styleguide/aboutguide.md b/pages/community/styleguide/aboutguide.md index 000eac0535f..e88af740399 100644 --- a/pages/community/styleguide/aboutguide.md +++ b/pages/community/styleguide/aboutguide.md @@ -16,6 +16,13 @@ This will help you in strategizing and simplifying your writing process. Before creating your first draft, it is beneficial to research similar resources and use them as references. Avoid plagiarism or copying and pasting from other websites unless the content already exists on our site. ### Follow the writing principles +When writing our content or documentation, we aim to achieve the following: +- **Clear** - It is very important that your writing is as clear as possible. Avoid using jargon or ambiguous words. +Explain any technical terms in simple and easy-to-understand words while considering your target audience. Additionally, keep your sentences short and sweet. +- **Concise** - When conveying information, it is crucial to be concise when writing content/documentation. This reduces redundancy and caters to the needs of the reader while providing value. +- **Consistent** - Maintaining consistency makes it easy for multiple collaborators to work together efficiently. This ensures professionalism while making it easy to implement updates and changes. +- **Friendly** - +- **Accurate** - ### Prune and polish From 6c96bf16295006fccb2ca8d22e546b50acf1a79e Mon Sep 17 00:00:00 2001 From: thulieblack Date: Tue, 7 Feb 2023 19:59:15 +0200 Subject: [PATCH 07/26] update --- pages/community/styleguide/aboutguide.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/pages/community/styleguide/aboutguide.md b/pages/community/styleguide/aboutguide.md index e88af740399..6c7086c0b17 100644 --- a/pages/community/styleguide/aboutguide.md +++ b/pages/community/styleguide/aboutguide.md @@ -19,10 +19,11 @@ Before creating your first draft, it is beneficial to research similar resources When writing our content or documentation, we aim to achieve the following: - **Clear** - It is very important that your writing is as clear as possible. Avoid using jargon or ambiguous words. Explain any technical terms in simple and easy-to-understand words while considering your target audience. Additionally, keep your sentences short and sweet. -- **Concise** - When conveying information, it is crucial to be concise when writing content/documentation. This reduces redundancy and caters to the needs of the reader while providing value. +- **Concise** - When conveying information, it is crucial to be concise. This reduces redundancy and caters to the needs of the reader while providing value. - **Consistent** - Maintaining consistency makes it easy for multiple collaborators to work together efficiently. This ensures professionalism while making it easy to implement updates and changes. -- **Friendly** - -- **Accurate** - +- **Friendly** - Your content/documentation should be relatable. Always use an active voice instead of a passive tone when writing. Moreover, adding some visual graphics and real-life examples helps the reader better understand the information more practically. + +- **Accurate** - Lastly, your content/documentation must be accurate and precise. The information provided should be well-researched, appropriate, and not misleading. Readers rely on our content/documentation to solve their needs while saving them time doing unnecessary research. ### Prune and polish From 015dc47be4e1ade09cf0bd8ce87f52b1667603cc Mon Sep 17 00:00:00 2001 From: thulieblack Date: Wed, 8 Feb 2023 18:12:16 +0200 Subject: [PATCH 08/26] update --- pages/community/styleguide/aboutguide.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/pages/community/styleguide/aboutguide.md b/pages/community/styleguide/aboutguide.md index 6c7086c0b17..69db4755c47 100644 --- a/pages/community/styleguide/aboutguide.md +++ b/pages/community/styleguide/aboutguide.md @@ -26,9 +26,10 @@ Explain any technical terms in simple and easy-to-understand words while conside - **Accurate** - Lastly, your content/documentation must be accurate and precise. The information provided should be well-researched, appropriate, and not misleading. Readers rely on our content/documentation to solve their needs while saving them time doing unnecessary research. -### Prune and polish +### Prune and polish +At this point, it is very important to check grammar, punctuation, and spelling. View your work with a constructive eye while putting yourself in the shoes of the reader. Thoroughly proofread your work and make use of tools such as Grammarly to help polish up your work. ### Ask for feedback - +There's a whole community of contributors who are willing to support you, so don't be shy to ask for feedback. You'll probably go through a lot of rounds of editing and proofreading before you can finally get your docs merged. From 744244572b5b3f120ff634d1b91f1acdf776f70f Mon Sep 17 00:00:00 2001 From: V Thulisile Sibanda <66913810+thulieblack@users.noreply.github.com> Date: Wed, 22 Feb 2023 12:05:01 +0200 Subject: [PATCH 09/26] Update pages/community/styleguide/aboutguide.md Co-authored-by: Alejandra Quetzalli --- pages/community/styleguide/aboutguide.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/pages/community/styleguide/aboutguide.md b/pages/community/styleguide/aboutguide.md index 69db4755c47..fce6a809dfc 100644 --- a/pages/community/styleguide/aboutguide.md +++ b/pages/community/styleguide/aboutguide.md @@ -1,5 +1,3 @@ -# AsyncAPI Style Guide - ## Introduction Welcome to the AsyncAPI Style Guide. This page serves as a guideline to contributors on how to write, structure, and format content/documentation. From 087db17143d2d97c335a3c43e4af5fe30426180e Mon Sep 17 00:00:00 2001 From: V Thulisile Sibanda <66913810+thulieblack@users.noreply.github.com> Date: Wed, 22 Feb 2023 12:05:15 +0200 Subject: [PATCH 10/26] Update pages/community/styleguide/aboutguide.md Co-authored-by: Alejandra Quetzalli --- pages/community/styleguide/aboutguide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pages/community/styleguide/aboutguide.md b/pages/community/styleguide/aboutguide.md index fce6a809dfc..9170ef4e4b7 100644 --- a/pages/community/styleguide/aboutguide.md +++ b/pages/community/styleguide/aboutguide.md @@ -1,5 +1,5 @@ ## Introduction -Welcome to the AsyncAPI Style Guide. This page serves as a guideline to contributors on how to write, structure, and format content/documentation. +Welcome to the AsyncAPI Style Guide. This page guides contributors on how to write, structure, and format content in documentation. These guidelines help us in maintaining language, tone, and voice throughout the website. It also makes it easier for multiple contributors to work together on a single doc while ensuring consistency, accuracy, and clarity. From e42551d785ea0e80c5adb16550d97f7ad13b2ba5 Mon Sep 17 00:00:00 2001 From: V Thulisile Sibanda <66913810+thulieblack@users.noreply.github.com> Date: Wed, 22 Feb 2023 12:05:24 +0200 Subject: [PATCH 11/26] Update pages/community/styleguide/aboutguide.md Co-authored-by: Alejandra Quetzalli --- pages/community/styleguide/aboutguide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pages/community/styleguide/aboutguide.md b/pages/community/styleguide/aboutguide.md index 9170ef4e4b7..6eb47d405b6 100644 --- a/pages/community/styleguide/aboutguide.md +++ b/pages/community/styleguide/aboutguide.md @@ -1,7 +1,7 @@ ## Introduction Welcome to the AsyncAPI Style Guide. This page guides contributors on how to write, structure, and format content in documentation. -These guidelines help us in maintaining language, tone, and voice throughout the website. It also makes it easier for multiple contributors to work together on a single doc while ensuring consistency, accuracy, and clarity. +These guidelines help us maintain language, tone, and voice throughout the website. It also makes it easier for multiple contributors to work together on a single doc while ensuring consistency, accuracy, and clarity. ## Writing Style Below are some recommendations to consider when writing your pages. From f2aade082ec5e3a4fb31d63e669653d83d5fcce1 Mon Sep 17 00:00:00 2001 From: V Thulisile Sibanda <66913810+thulieblack@users.noreply.github.com> Date: Wed, 22 Feb 2023 12:05:34 +0200 Subject: [PATCH 12/26] Update pages/community/styleguide/aboutguide.md Co-authored-by: Alejandra Quetzalli --- pages/community/styleguide/aboutguide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pages/community/styleguide/aboutguide.md b/pages/community/styleguide/aboutguide.md index 6eb47d405b6..bb46fde76ed 100644 --- a/pages/community/styleguide/aboutguide.md +++ b/pages/community/styleguide/aboutguide.md @@ -6,7 +6,7 @@ These guidelines help us maintain language, tone, and voice throughout the websi ## Writing Style Below are some recommendations to consider when writing your pages. -### Have your target audience in mind +### Identify target audience Before you begin planning and constructing your content, it is important to know who you are writing for and how the readers will benefit from your content. This will help you in strategizing and simplifying your writing process. From c514e413029fa5771d9d0c09c8bb7e531ccc4240 Mon Sep 17 00:00:00 2001 From: V Thulisile Sibanda <66913810+thulieblack@users.noreply.github.com> Date: Wed, 22 Feb 2023 12:05:46 +0200 Subject: [PATCH 13/26] Update pages/community/styleguide/aboutguide.md Co-authored-by: Alejandra Quetzalli --- pages/community/styleguide/aboutguide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pages/community/styleguide/aboutguide.md b/pages/community/styleguide/aboutguide.md index bb46fde76ed..f9d60482cd8 100644 --- a/pages/community/styleguide/aboutguide.md +++ b/pages/community/styleguide/aboutguide.md @@ -7,7 +7,7 @@ These guidelines help us maintain language, tone, and voice throughout the websi Below are some recommendations to consider when writing your pages. ### Identify target audience -Before you begin planning and constructing your content, it is important to know who you are writing for and how the readers will benefit from your content. +Before you begin planning and constructing your content, knowing who you are writing for and how the readers will benefit from your content is important. This will help you in strategizing and simplifying your writing process. ### Research From 47088c930c086aad98ba72d690f1920ced506444 Mon Sep 17 00:00:00 2001 From: V Thulisile Sibanda <66913810+thulieblack@users.noreply.github.com> Date: Wed, 22 Feb 2023 12:06:01 +0200 Subject: [PATCH 14/26] Update pages/community/styleguide/aboutguide.md Co-authored-by: Alejandra Quetzalli --- pages/community/styleguide/aboutguide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pages/community/styleguide/aboutguide.md b/pages/community/styleguide/aboutguide.md index f9d60482cd8..586993a8757 100644 --- a/pages/community/styleguide/aboutguide.md +++ b/pages/community/styleguide/aboutguide.md @@ -13,7 +13,7 @@ This will help you in strategizing and simplifying your writing process. ### Research Before creating your first draft, it is beneficial to research similar resources and use them as references. Avoid plagiarism or copying and pasting from other websites unless the content already exists on our site. -### Follow the writing principles +### Follow writing principles When writing our content or documentation, we aim to achieve the following: - **Clear** - It is very important that your writing is as clear as possible. Avoid using jargon or ambiguous words. Explain any technical terms in simple and easy-to-understand words while considering your target audience. Additionally, keep your sentences short and sweet. From 1f1da6d9fa80d517f19974db376d9de60650ad18 Mon Sep 17 00:00:00 2001 From: V Thulisile Sibanda <66913810+thulieblack@users.noreply.github.com> Date: Wed, 22 Feb 2023 12:06:31 +0200 Subject: [PATCH 15/26] Update pages/community/styleguide/aboutguide.md Co-authored-by: Alejandra Quetzalli --- pages/community/styleguide/aboutguide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pages/community/styleguide/aboutguide.md b/pages/community/styleguide/aboutguide.md index 586993a8757..25ac742fabe 100644 --- a/pages/community/styleguide/aboutguide.md +++ b/pages/community/styleguide/aboutguide.md @@ -14,7 +14,7 @@ This will help you in strategizing and simplifying your writing process. Before creating your first draft, it is beneficial to research similar resources and use them as references. Avoid plagiarism or copying and pasting from other websites unless the content already exists on our site. ### Follow writing principles -When writing our content or documentation, we aim to achieve the following: +When writing documentation, we aim to achieve the following: - **Clear** - It is very important that your writing is as clear as possible. Avoid using jargon or ambiguous words. Explain any technical terms in simple and easy-to-understand words while considering your target audience. Additionally, keep your sentences short and sweet. - **Concise** - When conveying information, it is crucial to be concise. This reduces redundancy and caters to the needs of the reader while providing value. From 1ebde1b940f229115aeb92601e06bf656086d7a3 Mon Sep 17 00:00:00 2001 From: V Thulisile Sibanda <66913810+thulieblack@users.noreply.github.com> Date: Wed, 22 Feb 2023 12:06:38 +0200 Subject: [PATCH 16/26] Update pages/community/styleguide/aboutguide.md Co-authored-by: Alejandra Quetzalli --- pages/community/styleguide/aboutguide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pages/community/styleguide/aboutguide.md b/pages/community/styleguide/aboutguide.md index 25ac742fabe..a88894d3121 100644 --- a/pages/community/styleguide/aboutguide.md +++ b/pages/community/styleguide/aboutguide.md @@ -17,7 +17,7 @@ Before creating your first draft, it is beneficial to research similar resources When writing documentation, we aim to achieve the following: - **Clear** - It is very important that your writing is as clear as possible. Avoid using jargon or ambiguous words. Explain any technical terms in simple and easy-to-understand words while considering your target audience. Additionally, keep your sentences short and sweet. -- **Concise** - When conveying information, it is crucial to be concise. This reduces redundancy and caters to the needs of the reader while providing value. +- **Concise** - It is crucial to be concise when conveying information. Removing redundancy caters to the reader's needs while providing value. - **Consistent** - Maintaining consistency makes it easy for multiple collaborators to work together efficiently. This ensures professionalism while making it easy to implement updates and changes. - **Friendly** - Your content/documentation should be relatable. Always use an active voice instead of a passive tone when writing. Moreover, adding some visual graphics and real-life examples helps the reader better understand the information more practically. From 328433e88208a10bb9e9a919078ee37ec2ea2010 Mon Sep 17 00:00:00 2001 From: V Thulisile Sibanda <66913810+thulieblack@users.noreply.github.com> Date: Wed, 22 Feb 2023 12:06:52 +0200 Subject: [PATCH 17/26] Update pages/community/styleguide/aboutguide.md Co-authored-by: Alejandra Quetzalli --- pages/community/styleguide/aboutguide.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/pages/community/styleguide/aboutguide.md b/pages/community/styleguide/aboutguide.md index a88894d3121..c4e3fb5e199 100644 --- a/pages/community/styleguide/aboutguide.md +++ b/pages/community/styleguide/aboutguide.md @@ -15,8 +15,7 @@ Before creating your first draft, it is beneficial to research similar resources ### Follow writing principles When writing documentation, we aim to achieve the following: -- **Clear** - It is very important that your writing is as clear as possible. Avoid using jargon or ambiguous words. -Explain any technical terms in simple and easy-to-understand words while considering your target audience. Additionally, keep your sentences short and sweet. +- **Clear** - It is very important that your writing is as clear as possible. Avoid using jargon or ambiguous words. Explain technical terms in simple and easy-to-understand words while considering your target audience. Additionally, keep your sentences short and sweet. - **Concise** - It is crucial to be concise when conveying information. Removing redundancy caters to the reader's needs while providing value. - **Consistent** - Maintaining consistency makes it easy for multiple collaborators to work together efficiently. This ensures professionalism while making it easy to implement updates and changes. - **Friendly** - Your content/documentation should be relatable. Always use an active voice instead of a passive tone when writing. Moreover, adding some visual graphics and real-life examples helps the reader better understand the information more practically. From 43dc048e609f132c60ce0b43cbeefcaca07d0202 Mon Sep 17 00:00:00 2001 From: V Thulisile Sibanda <66913810+thulieblack@users.noreply.github.com> Date: Wed, 22 Feb 2023 12:07:01 +0200 Subject: [PATCH 18/26] Update pages/community/styleguide/aboutguide.md Co-authored-by: Alejandra Quetzalli --- pages/community/styleguide/aboutguide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pages/community/styleguide/aboutguide.md b/pages/community/styleguide/aboutguide.md index c4e3fb5e199..ae0123dff59 100644 --- a/pages/community/styleguide/aboutguide.md +++ b/pages/community/styleguide/aboutguide.md @@ -18,7 +18,7 @@ When writing documentation, we aim to achieve the following: - **Clear** - It is very important that your writing is as clear as possible. Avoid using jargon or ambiguous words. Explain technical terms in simple and easy-to-understand words while considering your target audience. Additionally, keep your sentences short and sweet. - **Concise** - It is crucial to be concise when conveying information. Removing redundancy caters to the reader's needs while providing value. - **Consistent** - Maintaining consistency makes it easy for multiple collaborators to work together efficiently. This ensures professionalism while making it easy to implement updates and changes. -- **Friendly** - Your content/documentation should be relatable. Always use an active voice instead of a passive tone when writing. Moreover, adding some visual graphics and real-life examples helps the reader better understand the information more practically. +- **Friendly** - Your documentation should be relatable. Always use an active voice instead of a passive tone when writing. Moreover, adding visual graphics and real-life examples helps the reader understand the information more practically. - **Accurate** - Lastly, your content/documentation must be accurate and precise. The information provided should be well-researched, appropriate, and not misleading. Readers rely on our content/documentation to solve their needs while saving them time doing unnecessary research. From 160aba8e0ad07b66a12be571789a9e023bb475f6 Mon Sep 17 00:00:00 2001 From: V Thulisile Sibanda <66913810+thulieblack@users.noreply.github.com> Date: Wed, 22 Feb 2023 12:07:10 +0200 Subject: [PATCH 19/26] Update pages/community/styleguide/aboutguide.md Co-authored-by: Alejandra Quetzalli --- pages/community/styleguide/aboutguide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pages/community/styleguide/aboutguide.md b/pages/community/styleguide/aboutguide.md index ae0123dff59..7c20864c991 100644 --- a/pages/community/styleguide/aboutguide.md +++ b/pages/community/styleguide/aboutguide.md @@ -24,7 +24,7 @@ When writing documentation, we aim to achieve the following: ### Prune and polish -At this point, it is very important to check grammar, punctuation, and spelling. View your work with a constructive eye while putting yourself in the shoes of the reader. Thoroughly proofread your work and make use of tools such as Grammarly to help polish up your work. +It is crucial always to check grammar, punctuation, and spelling. View your work with a constructive eye while putting yourself in the reader's shoes. Thoroughly proofread your work and use writing tools such as Grammarly to polish up your work. ### Ask for feedback There's a whole community of contributors who are willing to support you, so don't be shy to ask for feedback. You'll probably go through a lot of rounds of editing and proofreading before you can finally get your docs merged. From 5e7372659101daaa4f29db7058e8429478dba058 Mon Sep 17 00:00:00 2001 From: V Thulisile Sibanda <66913810+thulieblack@users.noreply.github.com> Date: Wed, 22 Feb 2023 12:07:33 +0200 Subject: [PATCH 20/26] Update pages/community/styleguide/aboutguide.md Co-authored-by: Alejandra Quetzalli --- pages/community/styleguide/aboutguide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pages/community/styleguide/aboutguide.md b/pages/community/styleguide/aboutguide.md index 7c20864c991..150d13f149d 100644 --- a/pages/community/styleguide/aboutguide.md +++ b/pages/community/styleguide/aboutguide.md @@ -26,7 +26,7 @@ When writing documentation, we aim to achieve the following: ### Prune and polish It is crucial always to check grammar, punctuation, and spelling. View your work with a constructive eye while putting yourself in the reader's shoes. Thoroughly proofread your work and use writing tools such as Grammarly to polish up your work. -### Ask for feedback +### Adress feedback There's a whole community of contributors who are willing to support you, so don't be shy to ask for feedback. You'll probably go through a lot of rounds of editing and proofreading before you can finally get your docs merged. From 938b3b7e5985f8b43bdc48430818f04f93ee77f0 Mon Sep 17 00:00:00 2001 From: V Thulisile Sibanda <66913810+thulieblack@users.noreply.github.com> Date: Wed, 22 Feb 2023 12:07:42 +0200 Subject: [PATCH 21/26] Update pages/community/styleguide/aboutguide.md Co-authored-by: Alejandra Quetzalli --- pages/community/styleguide/aboutguide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pages/community/styleguide/aboutguide.md b/pages/community/styleguide/aboutguide.md index 150d13f149d..6204c6a38ba 100644 --- a/pages/community/styleguide/aboutguide.md +++ b/pages/community/styleguide/aboutguide.md @@ -27,6 +27,6 @@ When writing documentation, we aim to achieve the following: It is crucial always to check grammar, punctuation, and spelling. View your work with a constructive eye while putting yourself in the reader's shoes. Thoroughly proofread your work and use writing tools such as Grammarly to polish up your work. ### Adress feedback -There's a whole community of contributors who are willing to support you, so don't be shy to ask for feedback. You'll probably go through a lot of rounds of editing and proofreading before you can finally get your docs merged. +A whole community of contributors is willing to support you via detailed feedback. All documentation pull requests go through several rewriting, editing, and proofreading rounds before they're ready to merge. From b12d001a00387573778e8b4881c0ef3bede553cc Mon Sep 17 00:00:00 2001 From: thulieblack Date: Wed, 22 Feb 2023 12:57:07 +0200 Subject: [PATCH 22/26] add_plagiarism --- pages/community/styleguide/aboutguide.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/pages/community/styleguide/aboutguide.md b/pages/community/styleguide/aboutguide.md index 6204c6a38ba..b988144747a 100644 --- a/pages/community/styleguide/aboutguide.md +++ b/pages/community/styleguide/aboutguide.md @@ -13,6 +13,14 @@ This will help you in strategizing and simplifying your writing process. ### Research Before creating your first draft, it is beneficial to research similar resources and use them as references. Avoid plagiarism or copying and pasting from other websites unless the content already exists on our site. +### Plagiarism +Plagiarism can be defined as an act of using someone else's work as your own, without giving any acknowledgment or credit. These are some examples of plagiarism: +- Copying and pasting content word for word. +- Paraphrasing or making changes to the text without crediting the source. +- Using content written by someone else i.e ChatGPT. + + + ### Follow writing principles When writing documentation, we aim to achieve the following: - **Clear** - It is very important that your writing is as clear as possible. Avoid using jargon or ambiguous words. Explain technical terms in simple and easy-to-understand words while considering your target audience. Additionally, keep your sentences short and sweet. @@ -26,7 +34,7 @@ When writing documentation, we aim to achieve the following: ### Prune and polish It is crucial always to check grammar, punctuation, and spelling. View your work with a constructive eye while putting yourself in the reader's shoes. Thoroughly proofread your work and use writing tools such as Grammarly to polish up your work. -### Adress feedback +### Address feedback A whole community of contributors is willing to support you via detailed feedback. All documentation pull requests go through several rewriting, editing, and proofreading rounds before they're ready to merge. From 806e92925b5a4ceb51f65123c109f41c33cb02a8 Mon Sep 17 00:00:00 2001 From: thulieblack Date: Thu, 23 Feb 2023 11:44:13 +0200 Subject: [PATCH 23/26] update-plagiarism-text --- pages/community/styleguide/aboutguide.md | 16 ++++++++++++---- 1 file changed, 12 insertions(+), 4 deletions(-) diff --git a/pages/community/styleguide/aboutguide.md b/pages/community/styleguide/aboutguide.md index b988144747a..6f0e76309a2 100644 --- a/pages/community/styleguide/aboutguide.md +++ b/pages/community/styleguide/aboutguide.md @@ -14,12 +14,20 @@ This will help you in strategizing and simplifying your writing process. Before creating your first draft, it is beneficial to research similar resources and use them as references. Avoid plagiarism or copying and pasting from other websites unless the content already exists on our site. ### Plagiarism -Plagiarism can be defined as an act of using someone else's work as your own, without giving any acknowledgment or credit. These are some examples of plagiarism: -- Copying and pasting content word for word. -- Paraphrasing or making changes to the text without crediting the source. -- Using content written by someone else i.e ChatGPT. +Plagiarism can be defined as an act of using someone else's work as your own, without giving any acknowledgment or credit. Below are some scenarios that show plagiarism: +**Scenario 1** +Jane Doe is writing a docs page about APIs. She copies and pastes the content generated from ChatGPT word for word. + +**Scenario 2** + +John Doe is assigned a task to update graphics. He replicates some diagrams from an engineering book and doesn't give any credit to the author. + +You can avoid plagiarism by: +- Paraphrasing and adding your own thoughts. For instance, in the first scenario, you can use content generated from ChatGPT for research and reference purposes. +- Quoting or citing your sources. +- Using plagiarism checker tools such as Grammarly, SmallSEOTools, and Plagiarism Detector. ### Follow writing principles When writing documentation, we aim to achieve the following: From 21c158ca78f3b2472c722f1eac3ec4890c733db5 Mon Sep 17 00:00:00 2001 From: V Thulisile Sibanda <66913810+thulieblack@users.noreply.github.com> Date: Thu, 9 Mar 2023 20:30:38 +0200 Subject: [PATCH 24/26] Rename pages/community/styleguide/aboutguide.md to pages/docs/community/styleguide/aboutguide.md --- pages/{ => docs}/community/styleguide/aboutguide.md | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename pages/{ => docs}/community/styleguide/aboutguide.md (100%) diff --git a/pages/community/styleguide/aboutguide.md b/pages/docs/community/styleguide/aboutguide.md similarity index 100% rename from pages/community/styleguide/aboutguide.md rename to pages/docs/community/styleguide/aboutguide.md From d25e75445ba6e77818a83521f2f68d80873f57b2 Mon Sep 17 00:00:00 2001 From: V Thulisile Sibanda <66913810+thulieblack@users.noreply.github.com> Date: Thu, 9 Mar 2023 20:34:44 +0200 Subject: [PATCH 25/26] Update aboutguide.md --- pages/docs/community/styleguide/aboutguide.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/pages/docs/community/styleguide/aboutguide.md b/pages/docs/community/styleguide/aboutguide.md index 6f0e76309a2..38ed0a1ef66 100644 --- a/pages/docs/community/styleguide/aboutguide.md +++ b/pages/docs/community/styleguide/aboutguide.md @@ -1,3 +1,8 @@ +--- +title: About Guide +weight: 1 +--- + ## Introduction Welcome to the AsyncAPI Style Guide. This page guides contributors on how to write, structure, and format content in documentation. From f8ded38499fc915a5588d757d52a9d015107895e Mon Sep 17 00:00:00 2001 From: V Thulisile Sibanda <66913810+thulieblack@users.noreply.github.com> Date: Fri, 10 Mar 2023 09:09:58 +0200 Subject: [PATCH 26/26] Update pages/docs/community/styleguide/aboutguide.md Co-authored-by: Alejandra Quetzalli --- pages/docs/community/styleguide/aboutguide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pages/docs/community/styleguide/aboutguide.md b/pages/docs/community/styleguide/aboutguide.md index 38ed0a1ef66..196902b510b 100644 --- a/pages/docs/community/styleguide/aboutguide.md +++ b/pages/docs/community/styleguide/aboutguide.md @@ -1,5 +1,5 @@ --- -title: About Guide +title: About Style Guide weight: 1 ---