-
Notifications
You must be signed in to change notification settings - Fork 2.5k
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 API Gateway
keywords in English and Chinese docs
#7218
Comments
@navendu-pottekkat what do you think? Is this good for SEO? |
@moonming It might be a good idea. I have been adding keywords on the pages I have been re-writing. Currently, I follow this structure (for Plugins): ---
title: plugin name
keywords:
- APISIX
- Plugin
- Actual Plugin Name (Node status)
- apisix-plugin-name
description: This document contains information about the Apache APISIX plugin-name Plugin.
--- Adding this front matter should give better SEO than what we have before. We did not have any metadata of the pages before—no description or keywords. In SEO terms I'm not sure if adding a general keyword like "API Gateway" will help us or hinder us. Maybe @juzhiyuan has a better idea because he has been exploring SEO recently. If we decide to add this keyword, we can add a "good first label to this issue." Our current status is shown below: As you can see, we are in a sweet spot. |
Quote from itseeze.com
So, I guess we have to minimize the number of keywords. So, from a user viewpoint, we would ideally want them to easily find the documentation page with the web search. So, based on our current keywords, the user should be able to say, Google "How to use Apache Skywalking with APISIX" and it will hit the keyword and they can also Google "apisix skywalking plugin" and get the same page. This was my thought process when deciding the keywords. |
Agree. We may add this general keyword in the end, but we should first figure out who our visitors are and how to help them find content more easily. SEO is not I agree to add this general keyword for this issue, as it's expected in some tools indeed. 😂 |
NOTE: For any pages, we should limit the keyword count is less than 6 (would be better than 5). We can add: |
Keywords should have relations with the current doc/page. |
Hey! I Just Added The Relevant Keywords in English Docs Just Check it out. |
Current State
only Apache APISIX, no API Gateway keyword.
Desired State
see #7217
The text was updated successfully, but these errors were encountered: