-
-
Notifications
You must be signed in to change notification settings - Fork 114
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
Open
CBID2
wants to merge
53
commits into
asyncapi:master
Choose a base branch
from
CBID2:seo-guide
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
docs: add seo guide #1059
Changes from 1 commit
Commits
Show all changes
53 commits
Select commit
Hold shift + click to select a range
8f17680
docs: add seo guide
CBID2 995f474
feat: finish section on S
CBID2 a59d5e2
feat: add frontmatter
CBID2 30b0dbd
fix: omit heading 1
CBID2 29c82a2
Merge branch 'master' into seo-guide
quetzalliwrites 5b9d282
feat: made improvements in the sections about SEO and headings
CBID2 873c3d7
feat: revise sections about URL and alt text
CBID2 ea636c0
feat: add examples of SEO-friendly URLs
CBID2 02c1621
feat: add section for other ways to make Asyncapi's documentation SEO…
CBID2 b038d16
Merge branch 'master' into seo-guide
CBID2 4dd2cbe
Merge branch 'master' into seo-guide
quetzalliwrites 0ab1ee6
fix: remove addtional suggestions section
CBID2 a290e30
fix: omit bullet point
CBID2 1043e2d
fix: revise typos
CBID2 c5c2cb3
feat: created section for Anchor text
CBID2 e36abe0
feat: add explanation on what makes URL examples SEO-friendly
CBID2 dc7e656
feat add tips on making SEO-friendly anchor texts and a section for e…
CBID2 97ddcac
Merge branch 'master' into seo-guide
CBID2 f69a121
feat: add examples of SEO-friendly anchor texts
CBID2 cd32a5d
Merge branch 'master' into seo-guide
CBID2 91a9ba2
fix: revise meta description
CBID2 4d6a15f
feat: add explanation about what makes the example anchor text SEO-fr…
CBID2 ccbd863
fix: revise Markdown errors
CBID2 67082d4
Merge branch 'master' into seo-guide
CBID2 3810936
Merge branch 'master' into seo-guide
CBID2 a3d1deb
feat: add some comments
CBID2 1dc4c41
feat: finished adding more detail about headings and start another se…
CBID2 ae9d05d
feat: added new sections
CBID2 27225f7
fix: omit comment and revise markdown formatting
CBID2 100f76f
fix: revise headings
CBID2 6385f00
feat: finished section on meta descriptions
CBID2 4a75db2
Merge branch 'master' into seo-guide
CBID2 00944f1
feat: revise structure
CBID2 129986f
fix: remove period
CBID2 0f21cb8
docs: finished adding information about mobile and SEO-friendly techn…
CBID2 93580b4
docs: add Additional resources section
CBID2 8629680
docs: fix formatting issues
CBID2 c9c1068
Merge branch 'master' into seo-guide
CBID2 518fb48
docs: add section on image optimization
CBID2 3f67568
Merge branch 'master' into seo-guide
CBID2 21c7e1c
docs: made edits
CBID2 f551555
docs: fix explanation
CBID2 11a7898
Merge branch 'master' into seo-guide
CBID2 1e90fb7
Merge branch 'master' into seo-guide
CBID2 f3dc224
docs: revise description
CBID2 7bc89d6
Merge branch 'master' into seo-guide
CBID2 7c77e38
docs: change sentence
CBID2 c29c022
Merge branch 'master' into seo-guide
CBID2 8fde226
fix: revise errors
CBID2 8b21d9c
Merge branch 'master' into seo-guide
CBID2 18cb74d
Merge branch 'master' into seo-guide
CBID2 8d26291
Merge branch 'master' into seo-guide
CBID2 09c926d
Merge branch 'master' into seo-guide
thulieblack File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change | ||||
---|---|---|---|---|---|---|
@@ -0,0 +1,33 @@ | ||||||
# SEO | ||||||
|
||||||
## What is SEO? | ||||||
|
||||||
SEO (Search Engine Optimization)is the use of methods and strategies to ensure that a website's online content shows up when people search for them. | ||||||
|
||||||
### Why is important in our Documentation? | ||||||
|
||||||
Implementing SEO practices would make it easier for our users and others to find them. | ||||||
|
||||||
### 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 chronological 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. | ||||||
|
||||||
#### 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 add 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. | ||||||
|
||||||
#### 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: | ||||||
|
||||||
- |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.
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 comment
The 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.