Skip to content
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

Closed
moonming opened this issue Jun 9, 2022 · 7 comments · Fixed by #8993
Closed

docs: add API Gateway keywords in English and Chinese docs #7218

moonming opened this issue Jun 9, 2022 · 7 comments · Fixed by #8993
Labels
doc Documentation things

Comments

@moonming
Copy link
Member

moonming commented Jun 9, 2022

Current State

only Apache APISIX, no API Gateway keyword.

Desired State

see #7217

@moonming moonming added the doc Documentation things label Jun 9, 2022
@moonming
Copy link
Member Author

moonming commented Jun 9, 2022

@navendu-pottekkat what do you think? Is this good for SEO?

@pottekkat
Copy link
Member

@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:

Screenshot 2022-06-09 at 9 32 31 AM

As you can see, we are in a sweet spot.

@pottekkat
Copy link
Member

Quote from itseeze.com

It goes without saying, but do make sure you’re using your target keywords in both your page titles and your meta descriptions.

As page titles are used by Google to rank your website, including your chosen keywords will help to boost your position in search results for these terms. Whilst meta descriptions don’t directly contribute to your ranking, any keywords in your meta description will be highlighted if they match a searcher’s query, increasing your chances of that person visiting your website.

Each page on your website should ideally target one specific keyword. The most important keyword should always be placed at the start of the page title, and it’s a good idea to include your brand name too where possible, as this is also a keyword that you want to rank for.

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.

@juzhiyuan
Copy link
Member

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 Keyword only, and Google will consider many cases, including keyword matches, traffic on specific pages, and backlinks.

I agree to add this general keyword for this issue, as it's expected in some tools indeed. 😂

@juzhiyuan
Copy link
Member

NOTE: For any pages, we should limit the keyword count is less than 6 (would be better than 5).

We can add: APISIX, API Gateway, xxxx

@juzhiyuan
Copy link
Member

Keywords should have relations with the current doc/page.

@Ajay-singh1
Copy link
Contributor

Hey! I Just Added The Relevant Keywords in English Docs Just Check it out.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Documentation things
Projects
None yet
4 participants