feat(seo): optimize plugin titles and expand Getting Started guide#13222
Open
feat(seo): optimize plugin titles and expand Getting Started guide#13222
Conversation
Plugin title optimization (85 files): - Changed frontmatter titles from code identifiers to human-readable names - Format: "Human-Readable Name (code-identifier)" - Examples: limit-req → Rate Limiting (limit-req), openid-connect → OpenID Connect (openid-connect), grpc-transcode → gRPC Transcoding (grpc-transcode) - Only title field changed, no other content modified - Improves search visibility for long-tail queries like "API gateway rate limiting plugin" Getting Started expansion: - Expanded from ~300 words to ~800 words - Added: alternative installation methods table (Docker Compose, Helm, RPM, source), first route configuration example, plugin usage example (limit-count), dashboard access, troubleshooting section, improved next steps - Title changed from "Get APISIX" to "Getting Started with Apache APISIX" - Added comprehensive description meta tag
dosubot
bot
added
size:L
There was a problem hiding this comment.
Pull request overview
This PR focuses on documentation SEO improvements by making plugin page titles human-readable (while retaining the plugin code identifier) and expanding the English “Getting Started” guide to be a more complete local quickstart.
Changes:
- Updated plugin doc frontmatter
titlefields toHuman Name (plugin-id)for improved search relevance. - Expanded
docs/en/latest/getting-started/README.mdwith prerequisites, install options, first route + plugin examples, dashboard info, cleanup, and troubleshooting.
Reviewed changes
Copilot reviewed 86 out of 86 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/en/latest/plugins/zipkin.md | Frontmatter title made human-readable for SEO. |
| docs/en/latest/plugins/workflow.md | Frontmatter title made human-readable for SEO. |
| docs/en/latest/plugins/wolf-rbac.md | Frontmatter title made human-readable for SEO. |
| docs/en/latest/plugins/uri-blocker.md | Frontmatter title made human-readable for SEO. |
| docs/en/latest/plugins/udp-logger.md | Frontmatter title made human-readable for SEO. |
| docs/en/latest/plugins/ua-restriction.md | Frontmatter title made human-readable for SEO. |
| docs/en/latest/plugins/traffic-split.md | Frontmatter title made human-readable for SEO. |
| docs/en/latest/plugins/tencent-cloud-cls.md | Frontmatter title made human-readable for SEO. |
| docs/en/latest/plugins/tcp-logger.md | Frontmatter title made human-readable for SEO. |
| docs/en/latest/plugins/syslog.md | Frontmatter title made human-readable for SEO. |
| docs/en/latest/plugins/splunk-hec-logging.md | Frontmatter title made human-readable for SEO. |
| docs/en/latest/plugins/sls-logger.md | Frontmatter title made human-readable for SEO. |
| docs/en/latest/plugins/skywalking.md | Frontmatter title made human-readable for SEO. |
| docs/en/latest/plugins/skywalking-logger.md | Frontmatter title made human-readable for SEO. |
| docs/en/latest/plugins/serverless.md | Frontmatter title made human-readable for SEO. |
| docs/en/latest/plugins/server-info.md | Frontmatter title made human-readable for SEO. |
| docs/en/latest/plugins/rocketmq-logger.md | Frontmatter title made human-readable for SEO. |
| docs/en/latest/plugins/response-rewrite.md | Frontmatter title made human-readable for SEO. |
| docs/en/latest/plugins/request-validation.md | Frontmatter title made human-readable for SEO. |
| docs/en/latest/plugins/request-id.md | Frontmatter title made human-readable for SEO. |
| docs/en/latest/plugins/referer-restriction.md | Frontmatter title made human-readable for SEO. |
| docs/en/latest/plugins/redirect.md | Frontmatter title made human-readable for SEO. |
| docs/en/latest/plugins/real-ip.md | Frontmatter title made human-readable for SEO. |
| docs/en/latest/plugins/public-api.md | Frontmatter title made human-readable for SEO. |
| docs/en/latest/plugins/proxy-rewrite.md | Frontmatter title made human-readable for SEO. |
| docs/en/latest/plugins/proxy-mirror.md | Frontmatter title made human-readable for SEO. |
| docs/en/latest/plugins/proxy-control.md | Frontmatter title made human-readable for SEO. |
| docs/en/latest/plugins/proxy-cache.md | Frontmatter title made human-readable for SEO. |
| docs/en/latest/plugins/prometheus.md | Frontmatter title made human-readable for SEO. |
| docs/en/latest/plugins/openwhisk.md | Frontmatter title made human-readable for SEO. |
| docs/en/latest/plugins/opentelemetry.md | Frontmatter title made human-readable for SEO. |
| docs/en/latest/plugins/openid-connect.md | Frontmatter title made human-readable for SEO. |
| docs/en/latest/plugins/openfunction.md | Frontmatter title made human-readable for SEO. |
| docs/en/latest/plugins/opa.md | Frontmatter title made human-readable for SEO. |
| docs/en/latest/plugins/ocsp-stapling.md | Frontmatter title made human-readable for SEO. |
| docs/en/latest/plugins/node-status.md | Frontmatter title made human-readable for SEO. |
| docs/en/latest/plugins/mqtt-proxy.md | Frontmatter title made human-readable for SEO. |
| docs/en/latest/plugins/mocking.md | Frontmatter title made human-readable for SEO. |
| docs/en/latest/plugins/loki-logger.md | Frontmatter title made human-readable for SEO. |
| docs/en/latest/plugins/loggly.md | Frontmatter title made human-readable for SEO. |
| docs/en/latest/plugins/log-rotate.md | Frontmatter title made human-readable for SEO. |
| docs/en/latest/plugins/limit-req.md | Frontmatter title made human-readable for SEO. |
| docs/en/latest/plugins/limit-count.md | Frontmatter title made human-readable for SEO. |
| docs/en/latest/plugins/limit-conn.md | Frontmatter title made human-readable for SEO. |
| docs/en/latest/plugins/lago.md | Frontmatter title made human-readable for SEO. |
| docs/en/latest/plugins/kafka-proxy.md | Frontmatter title made human-readable for SEO. |
| docs/en/latest/plugins/kafka-logger.md | Frontmatter title made human-readable for SEO. |
| docs/en/latest/plugins/jwe-decrypt.md | Frontmatter title made human-readable for SEO. |
| docs/en/latest/plugins/ip-restriction.md | Frontmatter title made human-readable for SEO. |
| docs/en/latest/plugins/inspect.md | Frontmatter title made human-readable for SEO. |
| docs/en/latest/plugins/http-logger.md | Frontmatter title made human-readable for SEO. |
| docs/en/latest/plugins/http-dubbo.md | Frontmatter title made human-readable for SEO. |
| docs/en/latest/plugins/gzip.md | Frontmatter title made human-readable for SEO. |
| docs/en/latest/plugins/grpc-web.md | Frontmatter title made human-readable for SEO. |
| docs/en/latest/plugins/grpc-transcode.md | Frontmatter title made human-readable for SEO. |
| docs/en/latest/plugins/google-cloud-logging.md | Frontmatter title made human-readable for SEO. |
| docs/en/latest/plugins/gm.md | Frontmatter title made human-readable for SEO. |
| docs/en/latest/plugins/forward-auth.md | Frontmatter title made human-readable for SEO. |
| docs/en/latest/plugins/file-logger.md | Frontmatter title made human-readable for SEO. |
| docs/en/latest/plugins/fault-injection.md | Frontmatter title made human-readable for SEO. |
| docs/en/latest/plugins/ext-plugin-pre-req.md | Frontmatter title made human-readable for SEO. |
| docs/en/latest/plugins/ext-plugin-post-resp.md | Frontmatter title made human-readable for SEO. |
| docs/en/latest/plugins/ext-plugin-post-req.md | Frontmatter title made human-readable for SEO. |
| docs/en/latest/plugins/error-log-logger.md | Frontmatter title made human-readable for SEO. |
| docs/en/latest/plugins/elasticsearch-logger.md | Frontmatter title made human-readable for SEO. |
| docs/en/latest/plugins/echo.md | Frontmatter title made human-readable for SEO. |
| docs/en/latest/plugins/dubbo-proxy.md | Frontmatter title made human-readable for SEO. |
| docs/en/latest/plugins/degraphql.md | Frontmatter title made human-readable for SEO. |
| docs/en/latest/plugins/datadog.md | Frontmatter title made human-readable for SEO. |
| docs/en/latest/plugins/csrf.md | Frontmatter title made human-readable for SEO. |
| docs/en/latest/plugins/cors.md | Frontmatter title made human-readable for SEO. |
| docs/en/latest/plugins/consumer-restriction.md | Frontmatter title made human-readable for SEO. |
| docs/en/latest/plugins/client-control.md | Frontmatter title made human-readable for SEO. |
| docs/en/latest/plugins/clickhouse-logger.md | Frontmatter title made human-readable for SEO. |
| docs/en/latest/plugins/chaitin-waf.md | Frontmatter title made human-readable for SEO. |
| docs/en/latest/plugins/brotli.md | Frontmatter title made human-readable for SEO. |
| docs/en/latest/plugins/body-transformer.md | Frontmatter title made human-readable for SEO. |
| docs/en/latest/plugins/batch-requests.md | Frontmatter title made human-readable for SEO. |
| docs/en/latest/plugins/azure-functions.md | Frontmatter title made human-readable for SEO. |
| docs/en/latest/plugins/aws-lambda.md | Frontmatter title made human-readable for SEO. |
| docs/en/latest/plugins/authz-keycloak.md | Frontmatter title made human-readable for SEO. |
| docs/en/latest/plugins/authz-casdoor.md | Frontmatter title made human-readable for SEO. |
| docs/en/latest/plugins/authz-casbin.md | Frontmatter title made human-readable for SEO. |
| docs/en/latest/plugins/attach-consumer-label.md | Frontmatter title made human-readable for SEO. |
| docs/en/latest/plugins/api-breaker.md | Frontmatter title made human-readable for SEO. |
| docs/en/latest/getting-started/README.md | Expanded “Getting Started” content and updated page title/description for SEO. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Plugin title optimization (25 files): - Changed frontmatter titles from code identifiers to descriptive names only where the change adds meaningful clarity - Examples: limit-req → Rate Limiting (limit-req), limit-conn → Concurrency Limiting (limit-conn), grpc-transcode → gRPC Transcoding (grpc-transcode), degraphql → GraphQL to REST (degraphql), opa → Open Policy Agent (opa) - Skipped trivial changes where the title was already readable (e.g., batch-requests, proxy-cache, zipkin) - Only title field changed, no other content modified Getting Started expansion: - Expanded from ~300 words to ~800 words - Title: "Get APISIX" → "Getting Started with Apache APISIX" - Preserved canonical link and API7.ai contribution attribution - Added: alternative installation methods table, first route configuration, plugin usage example, troubleshooting section
Yilialinn
approved these changes
Apr 14, 2026
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary
SEO improvements to documentation: human-readable plugin page titles and expanded Getting Started guide.
Test plan
make build-docor equivalent)