Skip to content

docs: improve the Deployment Role document #7422

@juzhiyuan

Description

@juzhiyuan

Current State

Resource

  1. Document Link: https://apisix.apache.org/docs/apisix/next/architecture-design/deployment-role/

Improvements

  1. SEO: Missing keywords
  2. Deployment Role: What's a Role? Should it be options or modes?
  3. This document contains a table that explains what's traditional, decoupled, and standalone, but the description field misses details.
  4. For the traditional's description, it's DP + CP are deployed together by default. People need to disable enable_admin manually. How about updating it to XXXX. This mode enables "enable_admin" by default?
  5. This document mentions Control Plane. Some developers will get confused because of the relationship between Dashboard and AdminAPI.
  6. In the Traditional section, the diagram shows Admin API is listening on the 9180 port, but our document uses :9080/apisix/admin/XXX by default. Should we use the same port? Or should we explain why we use a different port?
  7. In the standalone section, we should also link readers to the Standalone document.
  8. How about adding more `reasons/benefits for each mode? The readers will know why and which way is suitable for their case.
  9. It's an English version only currently, need to translate to Chinese as well. cc @hf400159

Desired State

See Current State.

Metadata

Metadata

Assignees

No one assigned

    Labels

    discussdocDocumentation things

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions