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: improved SEO & fixed typo and localization issues #8993

Merged

Conversation

Neilblaze
Copy link
Contributor

@Neilblaze Neilblaze commented Mar 2, 2023

Description

Optimizing keywords and metadata of the docs enhances the SEO of APISIX & overall increases the accessibility for current and potential users. Hence, a few of the docs having "APISIX" has been updated to "Apache APISIX" (like the rest), and the keyword "API Gateway" or "API 网关" (in ZH) has been synchronously added to the list.

Moreover, a few typos and localization mistakes detected during the process have also been rectified.

Fixes: #7218
Refer to: #8966

cc: @juzhiyuan, @nfrankel, @navendu-pottekkat, @Ajay-singh1

Checklist

  • I have explained the need for this PR and the problem it solves
  • I have explained the changes or the new features added to this PR
  • I have verified that this change is backward compatible (If not, please discuss on the APISIX mailing list first)

Neilblaze and others added 2 commits March 2, 2023 17:20
Co-Authored-By: Ajay Singh <37625112+Ajay-singh1@users.noreply.github.com>
Signed-off-by: Pratyay Banerjee <dev@neilblaze.live>
Co-Authored-By: Navendu Pottekkat <navendu@apache.org>
@Ajay-singh1 Ajay-singh1 mentioned this pull request Mar 2, 2023
5 tasks
@Ajay-singh1
Copy link
Contributor

This PR fixes Issue ID #7218

Copy link
Member

@juzhiyuan juzhiyuan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM.

P.S. From my understanding, Google and other Search Engines don't rank pages according to keywords fields anymore 😅 but this PR does enhance the Apache APISIX branding.

- API 网关
- Plugin
- OpenTelemetry
- opentelemetry
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Keep one item is ok

Suggested change
- opentelemetry
- opentelemetry

Copy link
Contributor

@Ajay-singh1 Ajay-singh1 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Neilblaze Do some changes as mentioned by @juzhiyuan.

pottekkat
pottekkat previously approved these changes Mar 3, 2023
Copy link
Member

@pottekkat pottekkat left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM after @juzhiyuan 's comment

Signed-off-by: Pratyay Banerjee <dev@neilblaze.live>
Co-Authored-By: 琚致远 / Zhiyuan Ju <juzhiyuan@apache.org>
@Neilblaze
Copy link
Contributor Author

Neilblaze commented Mar 3, 2023

Damn, it's so annoying! :(
Apparently, GitHub web doesn't allow to trigger multiuser review requests at once lol

@Neilblaze
Copy link
Contributor Author

@Ajay-singh1 this is a low-priority PR. Reviewers are already tagged & they'll review it accordingly. Hence refrain from tagging them again and again!

@Ajay-singh1
Copy link
Contributor

@Neilblaze Ok!

@pottekkat pottekkat merged commit 1acee1b into apache:master Mar 6, 2023
hongbinhsu added a commit to fitphp/apix that referenced this pull request Mar 17, 2023
* upstream/master: (46 commits)
  fix(consumer): work if the etcd connection failed during starting (apache#9077)
  ci: fix low disk space error when loading saved docker images (apache#9080)
  change: change the default router from radixtree uri to radixtree hos… (apache#9047)
  chore(deps): bump dubbo from 2.7.18 to 2.7.21 in /t/lib/dubbo-backend/dubbo-backend-provider (apache#9041)
  fix: cli test on master (apache#9075)
  fix: Non wildcard origin in CORS should sent Vary header (apache#9010)
  feat: bump lua-resty-ldap version for ldap-auth (apache#9037)
  fix: invalidate cache in core.request.add_haeder and fix some calls (apache#8824)
  docs: remove unnecessary getting-started.md (apache#9054)
  docs: contribute Getting Started tutorials (apache#9046)
  docs: replace full-width quotation mark with half-width quotation mark (apache#8887)
  docs: fix typo and grammar (apache#9008)
  feat: ready to release 2.15.3 (apache#9021)
  ci: ensure the test can run with different repo name (apache#8832)
  chore(deps): bump golang.org/x/net from 0.0.0-20220722155237-a158d28d115b to 0.7.0 in /ci/pod/openfunction/function-example/test-uri (apache#9018)
  docs: improved SEO & fixed typo and localization issues (apache#8993)
  feat: release APISIX 3.2.0 (apache#8988)
  docs: fix grammar (apache#8935)
  docs: fix indent in encrypted-storage-fields (apache#8876)
  docs: k8s discovery: state the restriction on the use of port number (apache#8969)
  ...
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

docs: add API Gateway keywords in English and Chinese docs
5 participants