docs: add new dashboard documentation#12616
Merged
juzhiyuan merged 12 commits intoSep 16, 2025
Merged
Conversation
SkyeYoung
marked this pull request as ready for review
September 15, 2025 09:06
dosubot
Bot
added
size:L
SkyeYoung
requested review from
Baoyuantop,
bzp2010,
Copilot,
juzhiyuan and
kayx23
September 15, 2025 09:26
There was a problem hiding this comment.
Pull Request Overview
This PR adds comprehensive documentation for Apache APISIX Dashboard in both English and Chinese to help users understand and configure the Dashboard UI feature.
- Added new dashboard.md documentation files for both English and Chinese versions
- Updated getting-started README files to reference the new dashboard documentation
- Added dashboard entries to the navigation configuration
Reviewed Changes
Copilot reviewed 6 out of 12 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/zh/latest/getting-started/README.md | Added reference link to dashboard documentation |
| docs/zh/latest/dashboard.md | New comprehensive Chinese dashboard documentation |
| docs/zh/latest/config.json | Added dashboard navigation entry |
| docs/en/latest/getting-started/README.md | Added reference link to dashboard documentation |
| docs/en/latest/dashboard.md | New comprehensive English dashboard documentation |
| docs/en/latest/config.json | Added dashboard navigation entry |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
Co-authored-by: Copilot <[email protected]>
juzhiyuan
reviewed
Sep 16, 2025
juzhiyuan
previously approved these changes
Sep 16, 2025
Co-authored-by: Zhi Yuan Ju (琚致远) <[email protected]>
Baoyuantop
previously approved these changes
Sep 16, 2025
Baoyuantop
left a comment
Baoyuantop
left a comment
Contributor
There was a problem hiding this comment.
I think the PR title needs some optimization.
kayx23
previously approved these changes
Sep 16, 2025
Co-authored-by: Traky Deng <[email protected]>
kayx23
previously approved these changes
Sep 16, 2025
bzp2010
reviewed
Sep 16, 2025
|
|
||
| #### Using in Dashboard | ||
|
|
||
| Access the Dashboard, for example at `http://127.0.0.1:9180/ui`. |
Contributor
There was a problem hiding this comment.
Suggested change
| Access the Dashboard, for example at `http://127.0.0.1:9180/ui`. | |
| Access the Dashboard, for example at `http://127.0.0.1:9180/ui/`. |
Member
Author
There was a problem hiding this comment.
Do we need to update apisix-website repo as well to tweak the building process?
There will be a separate PR to handle this on apisix-website.
Co-authored-by: Zeping Bai <[email protected]>
bzp2010
approved these changes
Sep 16, 2025
kayx23
approved these changes
Sep 16, 2025
juzhiyuan
approved these changes
Sep 16, 2025
jizhuozhi
pushed a commit
to jizhuozhi/apisix
that referenced
this pull request
Oct 18, 2025
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.
Description
Added Apache APISIX Dashboard related documentation to enable users to use.
Which issue(s) this PR fixes:
Fixes #
Checklist