-
-
Notifications
You must be signed in to change notification settings - Fork 109
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 seo guide #1059
base: master
Are you sure you want to change the base?
docs: add seo guide #1059
Changes from 11 commits
8f17680
995f474
a59d5e2
30b0dbd
29c82a2
5b9d282
873c3d7
ea636c0
02c1621
b038d16
4dd2cbe
0ab1ee6
a290e30
1043e2d
c5c2cb3
e36abe0
dc7e656
97ddcac
f69a121
cd32a5d
91a9ba2
4d6a15f
ccbd863
67082d4
3810936
a3d1deb
1dc4c41
ae9d05d
27225f7
100f76f
6385f00
4a75db2
00944f1
129986f
0f21cb8
93580b4
8629680
c9c1068
518fb48
3f67568
21c7e1c
f551555
11a7898
1e90fb7
f3dc224
7bc89d6
7c77e38
c29c022
8fde226
8b21d9c
18cb74d
8d26291
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change | ||||
---|---|---|---|---|---|---|
@@ -0,0 +1,68 @@ | ||||||
--- | ||||||
title: SEO | ||||||
description: This guide gives advice on how to implement SEO when creating tutorials for our project. | ||||||
--- | ||||||
|
||||||
## What is SEO? | ||||||
|
||||||
SEO (Search Engine Optimization) refers to the methods and strategies used to enhance the visibility of a website's content in search engine results. | ||||||
|
||||||
### Why is important in our Documentation? | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Hey there, just a reminder that we observe sentence capitalization in headers. Please update and correct all headers accordingly :) There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. A reminder that the doc should be written to the audience via "you", not "we." Please go through your doc and update all mentions accordingly. |
||||||
|
||||||
Implementing SEO practices would make it easier for our users and others to find them, resulting in more contributions and people to our community. | ||||||
|
||||||
### SEO Best Practices | ||||||
|
||||||
#### Headings | ||||||
|
||||||
Headings are tags used to make sub titles distinctive from each other. When it comes to making them SEO-friendly, it's highly recommended to do the following: | ||||||
|
||||||
- **Put them in hierarchcial order:** Since an `h1` tag tend to be titles, always start with this tag. From there, use `h2` and`h3` tags for the subsections and `h4` and `h5` tags for other sections in your tutorial or other piece of documentation. | ||||||
- **Be descriptive:** Avoid using terms like "Conclusion" and "Introduction" due to their vagueness. Instead, make them specific and ensure they describe the section's content. | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
This advice contradicts our own documentation outline approach. All our tutorials intentionally have headers such as |
||||||
- **Include keywords:** Since sites like Google often use keywords to help people's online content appear on the web, Adding these terms effectively is helpful in reaching the tutorials or other pieces of content you create for our project to a wider audience. | ||||||
|
||||||
Here's an example of SEO-friendly headings: | ||||||
|
||||||
```md | ||||||
# Server | ||||||
## What is Server? | ||||||
## What is the purpose of servers? | ||||||
### Cilent and Server | ||||||
``` | ||||||
|
||||||
#### Alt Text | ||||||
|
||||||
Alt text are short descriptions of images used to help Google and people who use screen readers gain a better understanding of our tutorials and other pieces of content. To make them SEO-friendly, it's highly recommended to do the following: | ||||||
|
||||||
- **Describe the image accurately**: Doing this would help our users understand how to use Asycapi in their work. | ||||||
- **Be concise**: While accuracy is important, avoid writing every single detail about the image. | ||||||
- **Use keywords strategically**: Avoid adding every single keyword to your image's alt text. It can overwhelm Google's search engine. | ||||||
|
||||||
Here's an example of effective alternative text: | ||||||
|
||||||
```html | ||||||
alt="Diagram of EDAs" | ||||||
``` | ||||||
|
||||||
#### URLs | ||||||
|
||||||
URLs are addresses to webpages and other forms of online content. In the context of SEO, they help make it easier for users to gain access content. To make them more SEO-friendly, use the following methods: | ||||||
|
||||||
- **Make them short:** It'll make the links easier for users to comprehend and find the needed tutorial on our website | ||||||
- **Use keywords**: Like alt text, effectively adding keywords in the URL would make it easier for Google to find them. | ||||||
- **Avoid using special characters and spaces:** Use hyphens (-) instead of underscores (_) to separate words in URLs, as search engines treat hyphens as space. | ||||||
|
||||||
Here are some examples of SEO-friendly URLs from our documentation: | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. What makes these links SEO friendly? We should also explain how the URL clearly shows our content buckets. |
||||||
- `https://www.asyncapi.com/docs/concepts/application` | ||||||
- `https://www.asyncapi.com/docs/concepts/server` | ||||||
- `https://www.asyncapi.com/docs/concepts/message` | ||||||
|
||||||
#### Additional Suggestions | ||||||
- **Meta Descriptions:** Our current docs and blog posts all use meta descriptions and titles. These summaries appear under the title in search results and can significantly impact click-through rates. | ||||||
- **Mobile-Friendliness:** Mention the importance of ensuring that documentation is mobile-friendly, as this is a factor in search engine rankings. | ||||||
- **Internal Linking:** Encourage the use of internal linking to other parts of the documentation or the AsyncAPI website to boost SEO and user navigation. | ||||||
- **Content Quality:** Emphasize the importance of high-quality, original content. Search engines favor content that provides value to users. | ||||||
**Anchor Text:** | ||||||
- Be descriptive and relevant. | ||||||
- Avoid generic phrases like "click here" or "this page". (Instead, use meaningful phrases that give users and search engines an idea of what to expect on the linked page.) | ||||||
- Vary your anchor text. While it's important to be descriptive, using the exact same anchor text for every link to a particular page can appear spammy to search engines. Try to vary the phrasing while still being clear about the page content. | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. What is this? Why did you copy/paste my feedback comment into the documentation? You were supposed to apply the feedback for writing the missing content. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I was under the impression that this information needed to be added to the guide. My mistake |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
📣 Feedback for Draft 1
What is SEO?
The definition is accurate but could be slightly rephrased. For example, "SEO (Search Engine Optimization) refers to the methods and strategies used to enhance the visibility of a website's content in search engine results."
Why is it important in our Documentation?
Could you add a sentence about the potential for increased contributions and community growth through effective SEO?
Headings
Alt Text
URLs
asyncapi.com/docs/concepts/server
Additional Suggestions