-
-
Notifications
You must be signed in to change notification settings - Fork 10.2k
docs: add Dameng (DM) database adapter to deployment guide#5569
Open
ajistyle wants to merge 5 commits intoapolloconfig:masterfrom
Open
docs: add Dameng (DM) database adapter to deployment guide#5569ajistyle wants to merge 5 commits intoapolloconfig:masterfrom
ajistyle wants to merge 5 commits intoapolloconfig:masterfrom
Conversation
Fixes #5546
Zai Fen Bu Shi Bu Shu Zhi Nan De Shu Ju Ku Gua Pei Can Kao Chu Zeng Jia Da Meng (Dameng DM) She Qu Gua Pei Shuo Ming :
- Zhong Wen Bu Shu Zhi Nan :Zai 1.2 MySQL Jie Zhu 3 Hou Xin Zeng Zhu 4,Zhi Xiang ajistyle/apollo-dameng
- Ying Wen Bu Shu Zhi Nan :Tong Bu Zeng Jia Note 4
- Gua Pei Ji Xian :Apollo 2.1.0;Ce Shi Guo De Da Meng Ban Ben :DM8;Biao Zhu Wei She Qu Wei Hu (community-maintained)
Summary by CodeRabbit
- Documentation
- Added Dameng (DM) demo link in README and DM deployment reference in English/Chinese distributed deployment guides
- Introduced Flyway-based and manual SQL import workflows for PortalDB/ConfigDB with verification steps and version notes
- Updated SQL script paths and import commands; reorganized deployment flow, anchors, and cross-references
- Standardized example keys (e.g., LDAP/YAML to camelCase), cleaned up obsolete notes and editorial inconsistencies
|
CLA Assistant Lite bot All contributors have signed the CLA |
Contributor
|
Note Reviews pausedIt looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the Use the following commands to manage reviews:
Use the checkboxes below for quick actions:
WalkthroughWalkthroughAdded Dameng (Da Meng ) community adaptation references to README and both English/Chinese distributed-deployment guides; introduced Flyway-based SQL import steps for portal/config DBs; standardized LDAP config keys to camelCase; and updated documentation links, SQL paths, and Kubernetes/Helm examples. Changes
Estimated code review effort3 (Moderate) | ~20 minutes Possibly related PRs
Suggested labels
Suggested reviewers
Poem
Pre-merge checks | 4 | 1Failed checks (1 inconclusive)
Passed checks (4 passed)
Tip: You can configure your own custom pre-merge checks in the settings. Finishing TouchesGenerate unit tests (beta)
Tip Try Coding Plans. Let us write the prompt for your AI agent so you can ship faster (with fewer bugs). Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Contributor
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 3
Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@docs/en/deployment/distributed-deployment-guide.md`:
- Around line 269-270: Update the documentation step that lists Flyway config
keys in flyway-configdb.properties to include flyway.url and remove the
duplicate flyway.password; specifically, change the list that currently reads
"flyway.user, flyway.password, and flyway.password" to "flyway.url, flyway.user,
and flyway.password" so readers correctly set flyway.url in
flyway-configdb.properties before running mvn -N -Pconfigdb flyway:migrate.
- Line 1330: Remove the duplicated trailing fragment "portal's meta-service
information)." from Note 2 so the sentence reads cleanly; update the sentence
that mentions apollo-portal and apollo-client (the one referencing [2.2.1.1.2.4
Configuring the meta service information of apollo-portal] and [1.2.2 Apollo
Meta Server]) to eliminate the stray text and ensure the links and parentheses
are balanced and grammatically correct.
In `@docs/zh/deployment/distributed-deployment-guide.md`:
- Line 675: The section header "##### 2.2.3.5.2 2.1.0 Zhi Qian De Ban Ben " is numbered
incorrectly relative to its parent "2.2.3.4 custom-defined-discovery"; update
the header text to "##### 2.2.3.4.2 2.1.0 Zhi Qian De Ban Ben " so the section number matches
the parent hierarchy and fixes TOC/reference consistency.
i Review info
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Files selected for processing (3)
README.mddocs/en/deployment/distributed-deployment-guide.mddocs/zh/deployment/distributed-deployment-guide.md
Author
|
I have read the CLA Document and I hereby sign the CLA |
ajistyle
force-pushed
the
docs/add-dameng-adapter
branch
from
February 27, 2026 00:56
5ebdb31 to
88bbcbc
Compare
Author
|
I have read the CLA Document and I hereby sign the CLA |
Contributor
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Duplicate comments (3)
docs/zh/deployment/distributed-deployment-guide.md (1)
675-675:Potential issue | Minor Zhang Jie Bian Hao Cuo Wu (Ying Wei 2.2.3.4.2).
Dang Qian Wei Yu
2.2.3.4 custom-defined-discoveryXiao Jie Xia ,Dan Biao Ti Xie Cheng Liao2.2.3.5.2,Hui Dao Zhi Mu Lu /Yin Yong Li Jie Hun Luan .Jian Yi Xiu Zheng
-##### 2.2.3.5.2 2.1.0 Zhi Qian De Ban Ben
+##### 2.2.3.4.2 2.1.0 Zhi Qian De Ban BenPrompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs/zh/deployment/distributed-deployment-guide.md` at line 675, Dang Qian Xiao Jie Biao Ti
"##### 2.2.3.5.2 2.1.0 Zhi Qian De Ban Ben " Yu Suo Zai Fu Zhang Jie "2.2.3.4 custom-defined-discovery"
Bu Pi Pei ;Qing Jiang Gai Biao Ti Wen Ben Zhong De Zhang Jie Bian Hao Cong "2.2.3.5.2" Xiu Gai Wei "2.2.3.4.2"(Ji Ba Biao Ti Gai Wei "##### 2.2.3.4.2 2.1.0
Zhi Qian De Ban Ben "),Yi Bao Chi Mu Lu He Yin Yong Yi Zhi .docs/en/deployment/distributed-deployment-guide.md (2)
1330-1330:Potential issue | Minor Remove duplicated trailing phrase in Note 2.
The sentence contains an extra fragment (
portal's meta-service information).) that breaks readability and looks like a merge/edit artifact.Suggested doc fix
Note 2: Adding the environment in the database alone is not enough; you also need to add the new environment's meta server address for apollo-portal, see [2.2.1.1.2.4 Configuring the meta service information of apollo-portal](en/deployment/distributed-deployment-guide?id =_221124-configuring-apollo-portal39s-meta-service-informati on). apollo-client also needs corresponding configuration in the new environment, see [1.2.2 Apollo Meta Server](en/usage/java-sdk-user-guide?id=_122-apollo-meta-server).">->Note 2: Adding the environment to the database only does not work, you also need to add the meta server address corresponding to the new environment for apollo-portal, refer to: [2.2.1.1.2.4 Configuring the meta service information of apollo-portal](en/deployment/distributed-deployment-guide?id =_221124-configuring-apollo-portal39s-meta-service-informati on). portal's meta-service information). apollo-client also needs to be configured accordingly when used in a new environment, refer to: [1.2.2 Apollo Meta Server](en/usage/java-sdk-user-guide?id=_122-apollo-meta-server).
+>Note 2: Adding the environment in the database alone is not enough; you also need to add the new environment's meta server address for apollo-portal, see [2.2.1.1.2.4 Configuring the meta service information of apollo-portal](en/deployment/distributed-deployment-guide?id =_221124-configuring-apollo-portal39s-meta-service-informati on). apollo-client also needs corresponding configuration in the new environment, see [1.2.2 Apollo Meta Server](en/usage/java-sdk-user-guide?id=_122-apollo-meta-server).Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs/en/deployment/distributed-deployment-guide.md` at line 1330, The Note 2
sentence contains a duplicated trailing fragment "portal's meta-service
information)." Remove that duplicated fragment from the sentence in Note 2 and
ensure the two reference links remain intact and correctly formatted (the
references to "2.2.1.1.2.4 Configuring the meta service information of
apollo-portal" and "1.2.2 Apollo Meta Server" should be preserved); update the
line so it reads smoothly without the extra "portal's meta-service
information)."
269-270:
Fix Flyway config key list (flyway.url is missing).
The sentence currently lists flyway.password twice, so users may miss configuring flyway.url.
Suggested doc fix
-1. Modify the `flyway.user`, `flyway.password`, and `flyway.password` in [flyway-configdb.properties](https://github.com/apolloconfig /apollo/blob/master/scripts/flyway/flyway-configdb.propertie s) .
+1. Modify `flyway.user`, `flyway.password`, and `flyway.url` in [flyway-configdb.properties](https://github.com/apolloconfig/apollo/blob/master/scripts/flyway/flyway-configdb.properties).
+1. Modify `flyway.user`, `flyway.password`, and `flyway.url` in [flyway-configdb.properties](https://github.com/apolloconfig/apollo/blob/master/scripts/flyway/flyway-configdb.properties).
Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs/en/deployment/distributed-deployment-guide.md` around lines 269 - 270,
Update the Flyway config key list to include `flyway.url` and remove the
duplicated `flyway.password` entry in the `flyway-configdb.properties`
instructions: change "Modify the `flyway.user`, `flyway.password`, and
`flyway.password`" to "Modify the `flyway.url`, `flyway.user`, and
`flyway.password`" so users are prompted to set the JDBC URL along with username
and password before running `mvn -N -Pconfigdb flyway:migrate`.
Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Duplicate comments:
In `@docs/en/deployment/distributed-deployment-guide.md`:
- Line 1330: The Note 2 sentence contains a duplicated trailing fragment
"portal's meta-service information)." Remove that duplicated fragment from the
sentence in Note 2 and ensure the two reference links remain intact and
correctly formatted (the references to "2.2.1.1.2.4 Configuring the meta service
information of apollo-portal" and "1.2.2 Apollo Meta Server" should be
preserved); update the line so it reads smoothly without the extra "portal's
meta-service information)."
- Around line 269-270: Update the Flyway config key list to include `flyway.url`
and remove the duplicated `flyway.password` entry in the
`flyway-configdb.properties` instructions: change "Modify the `flyway.user`,
`flyway.password`, and `flyway.password`" to "Modify the `flyway.url`,
`flyway.user`, and `flyway.password`" so users are prompted to set the JDBC URL
along with username and password before running `mvn -N -Pconfigdb
flyway:migrate`.
In `@docs/zh/deployment/distributed-deployment-guide.md`:
- Line 675: Dang Qian Xiao Jie Biao Ti "##### 2.2.3.5.2 2.1.0 Zhi Qian De Ban Ben " Yu Suo Zai Fu Zhang Jie "2.2.3.4
custom-defined-discovery" Bu Pi Pei ;Qing Jiang Gai Biao Ti Wen Ben Zhong De Zhang Jie Bian Hao Cong "2.2.3.5.2" Xiu Gai Wei "2.2.3.4.2"(Ji Ba Biao Ti Gai Wei
"##### 2.2.3.4.2 2.1.0 Zhi Qian De Ban Ben "),Yi Bao Chi Mu Lu He Yin Yong Yi Zhi .
i Review info
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Files selected for processing (2)
docs/en/deployment/distributed-deployment-guide.mddocs/zh/deployment/distributed-deployment-guide.md
Author
|
Yi An review Yi Jian Xiu Gai (Zhang Jie Hao , Note 2 Zhong Fu Ju , Flyway Pei Zhi Xiang Lie Biao ),Qing You Kong Shi Zai Kan Yi Xia . |
...te 2, fix Flyway config list (add flyway.url)
ajistyle
force-pushed
the
docs/add-dameng-adapter
branch
from
February 27, 2026 01:07
f4801cb to
b7751fe
Compare
Contributor
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 4
Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@docs/en/deployment/distributed-deployment-guide.md`:
- Around line 520-524: The three blockquote notes labeled "Note 3", "Note 4",
and "Note 5" are separated by blank lines which triggers markdownlint MD028;
remove the empty lines so the consecutive lines starting with "> Note 3", ">
Note 4", and "> Note 5" are contiguous blockquote lines (no blank lines between
them) to satisfy linting and ensure consistent rendering.
- Line 1560: The cross-reference link text
[apollo.eureka.server.security.enabled](`#_329-apolloeurekaserversecurityenabled`...)
points to a non-existent fragment; locate the heading that documents the
apollo.eureka.server.security.enabled setting (search for its exact heading
text) and replace the broken anchor with the heading's actual slug/fragment (for
example use the heading's generated fragment like
"#apollo-eureka-server-security-enabled" or the exact fragment shown in the
TOC), ensuring the link target exactly matches the heading fragment so the MD051
error is resolved.
In `@docs/zh/deployment/distributed-deployment-guide.md`:
- Line 1280: The in-page link fragments are invalid (anchors
"#_221124-Pei Zhi apollo-portalDe meta-serviceXin Xi " and
"zh/usage/java-sdk-user-guide#_122-apollo-meta-server") and cause MD051 errors;
fix them by locating the actual headings for "Pei Zhi apollo-portalDe meta serviceXin Xi "
and "Apollo Meta Server" in the docs and replace these fragments with the exact
heading anchors used by the renderer (match casing, punctuation and anchor
generation rules), or convert to relative links that point to the correct
section names; update both occurrences (including the one noted at lines ~1501)
so the links resolve correctly.
- Around line 499-503: Remove the blank lines between the consecutive blockquote
notes so the three blockquotes starting with "> Zhu 3", "> Zhu 4", and "> Zhu 5" become
contiguous (no empty lines between them) to satisfy markdownlint rule MD028 and
preserve proper blockquote rendering.
i Review info
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Files selected for processing (2)
docs/en/deployment/distributed-deployment-guide.mddocs/zh/deployment/distributed-deployment-guide.md
Contributor
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 2
Duplicate comments (4)
docs/en/deployment/distributed-deployment-guide.md (2)
520-524:Potential issue | Minor Remove blank lines between consecutive blockquote notes.
Blank lines between
> Note 3,> Note 4, and> Note 5trigger markdownlint MD028 and may cause inconsistent rendering. These blockquotes should be contiguous (no blank lines between them).Suggested fix
> Note 3: To adjust the listening port of the service, you can modify the `SERVER_PORT` in scripts/startup.sh. In addition, apollo-configservice also assumes the responsibility of meta server. If you want to modify the port, pay attention to the `eureka.service.url` configuration item in the ApolloConfigDB.ServerConfig table and the meta server information used in apollo-portal and apollo-client. For details, see: [2.2.1.1.2.4 Configuring the meta service information of apollo-portal](en/deployment/distributed-deployment-guide?id =_221124-configuring-apollo-portal39s-meta-service-informati on) and [1.2.2 Apollo Meta Server](en/usage/java-sdk-user-guide?id=_122-apollo-meta-server).
-
> Note 4: If the eureka.service.url of ApolloConfigDB.ServerConfig is only configured with the currently starting machine, the eureka registration failure information will be output in the log during the process of starting apollo-configservice, such as `com.sun.jersey.api.client.ClientHandlerException: java.net.ConnectException: Connection refused`. It should be noted that this is the expected situation, because apollo-configservice needs to register the service with the Meta Server (itself), but because it has not yet woken up during the startup process, it will report this error. The retry action will be performed later, so the registration will be normal after the service is up.
-
> Note 5: If you read this, I believe that you must be someone who reads the documentation carefully, and you are a little bit closer to success. Keep going, you should be able to complete the distributed deployment of Apollo soon! But do you feel that Apollo's distributed deployment steps are a bit cumbersome? Do you have any advice you would like to share with the author? If the answer is yes, please move to [`#1424`](https://github.com/apolloconfig/apollo/issues/1424 ) and look forward to your suggestions!Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs/en/deployment/distributed-deployment-guide.md` around lines 520 - 524,
Remove the blank lines separating the consecutive blockquote notes so they
become contiguous blockquotes: collapse the empty lines between the lines
starting with "> Note 3:", "> Note 4:" and "> Note 5:" so the three notes are
adjacent without intervening blank lines; verify the blockquotes render as a
single contiguous block (addresses the MD028 markdownlint warning).
1560-1560:Potential issue | Minor Fix invalid cross-reference link fragment.
The link fragment
#_329-apolloeurekaserversecurityenabledis flagged as invalid by markdownlint MD051. Please locate the actual heading for section 3.2.9 "apollo.eureka.server.security.enabled" and update the anchor to match the heading's generated fragment.#!/bin/bash
# Description: Find the correct heading and anchor for section 3.2.9
# Search for the heading text
rg -n "3\.2\.9.*apollo\.eureka\.server\.security\.enabled" docs/en/deployment/distributed-deployment-guide.md
# Check what the heading looks like
rg -n "^###.*apollo\.eureka\.server\.security\.enabled" docs/en/deployment/distributed-deployment-guide.md -A 1Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs/en/deployment/distributed-deployment-guide.md` at line 1560, The link
fragment "#_329-apolloeurekaserversecurityenabled" is invalid; find the actual
section heading for "3.2.9 apollo.eureka.server.security.enabled" in the
document and replace the broken fragment with the heading's generated anchor
(the markdown-generated fragment derived from the exact heading text) so the
link points to the correct anchor; search for the heading string
"apollo.eureka.server.security.enabled" to locate the exact heading
spelling/casing and update the link in the sentence that currently references
apollo.eureka.server.security.enabled accordingly.
docs/zh/deployment/distributed-deployment-guide.md (2)
499-503:Potential issue | Minor Yi Chu Lian Xu Yin Yong Kuai Zhi Jian De Kong Xing .
> Zhu 3,> Zhu 4He> Zhu 5Zhi Jian De Kong Xing Hui Hong Fa markdownlint MD028 Gui Ze ,Ke Neng Dao Zhi Xuan Ran Bu Yi Zhi . Zhe Xie Yin Yong Kuai Ying Gai Lian Xu (Zhi Jian Mei You Kong Xing ).Jian Yi Xiu Fu
> Zhu 3:Ru Yao Diao Zheng Fu Wu De Jian Ting Duan Kou ,Ke Yi Xiu Gai scripts/startup.shZhong De `SERVER_PORT`. Ling Wai apollo-configserviceTong Shi Cheng Dan meta serverZhi Ze ,Ru Guo Yao Xiu Gai Duan Kou ,Zhu Yi Yao Tong Shi ApolloConfigDB.ServerConfigBiao Zhong De `eureka.service.url`Pei Zhi Xiang Yi Ji apollo-portalHe apollo-clientZhong De Shi Yong Dao De meta serverXin Xi ,Xiang Jian :[2.2.1.1.2.4 Pei Zhi apollo-portalDe meta serviceXin Xi ](`#_221124-Pei Zhi apollo-portalDe meta-serviceXin Xi `)He [1.2.2 Apollo Meta Server](zh/usage/java-sdk-user-guide#_122-apollo-meta-server ).
-
> Zhu 4:Ru Guo ApolloConfigDB.ServerConfigDe eureka.service.urlZhi Pei Liao Dang Qian Zheng Zai Qi Dong De Ji Qi De Hua ,Zai Qi Dong apollo-configserviceDe Guo Cheng Zhong Hui Zai Ri Zhi Zhong Shu Chu eurekaZhu Ce Shi Bai De Xin Xi ,Ru `com.sun.jersey.api.client.ClientHandlerException: java.net.ConnectException: Connection refused`. Xu Yao Zhu Yi De Shi ,Zhe Ge Shi Yu Qi De Qing Kuang ,Yin Wei apollo-configserviceXu Yao Xiang Meta Server(Ta Zi Ji )Zhu Ce Fu Wu ,Dan Shi Yin Wei Zai Qi Dong Guo Cheng Zhong ,Zi Ji Huan Mei Qi Lai ,Suo Yi Hui Bao Zhe Ge Cuo . Hou Mian Hui Jin Xing Zhong Shi De Dong Zuo ,Suo Yi Deng Zi Ji Fu Wu Qi Lai Hou Jiu Hui Zhu Ce Zheng Chang Liao .
-
> Zhu 5:Ru Guo Ni Kan Dao Liao Zhe Li ,Xiang Xin Ni Yi Ding Shi Yi Ge Xi Xin Yue Du Wen Dang De Ren ,Er Qie Chi Cheng Gong Jiu Chai Yi Dian Dian Liao ,Ji Xu Jia You ,Ying Gai Hen Kuai Jiu Neng Wan Cheng ApolloDe Fen Bu Shi Bu Shu Liao !Bu Guo Ni Shi Fou You Gan Jue ApolloDe Fen Bu Shi Bu Shu Bu Zou You Dian Fan Suo ?Shi Fou You Sha Jian Yi Xiang Yao He Zuo Zhe Shuo ?Ru Guo Da An Shi Ken Ding De Hua ,Qing Yi Bu [`#1424`](https://github.com/apolloconfig/apollo/issues/1424 ),Qi Dai Ni De Jian Yi !Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs/zh/deployment/distributed-deployment-guide.md` around lines 499 - 503,
Remove the blank lines between the consecutive blockquotes so the three note
blocks starting with "> Zhu 3", "> Zhu 4" and "> Zhu 5" are contiguous (no empty lines
between them) to satisfy markdownlint MD028; edit the quoted lines in the given
section so they appear back-to-back as continuous blockquote content.
1280-1280:Potential issue | Minor Xiu Fu Wu Xiao De Ye Nei Lian Jie Mao Dian .
Zhe Xie Jiao Cha Yin Yong De Mao Dian Bei markdownlint MD051 Biao Ji Wei Wu Xiao . Qing Zhao Dao Shi Ji De Zhang Jie Biao Ti Bing Geng Xin Mao Dian Yi Pi Pei Biao Ti Sheng Cheng De Pian Duan .
Zai 1280 Xing ,Mao Dian
#_221124-Pei Zhi apollo-portalDe meta-serviceXin XiHezh/usage/java-sdk-user-guide#_122-apollo-meta-serverXu Yao Yan Zheng .Zai 1501 Xing ,Mao Dian
#_329-apolloeurekaserversecurityenabled-Pei Zhi Shi Fou Kai Qi eureka-serverDe Deng Lu Ren ZhengXu Yao Yan Zheng .#!/bin/bash
# Description: Cha Zhao Zheng Que De Biao Ti He Mao Dian
# Sou Suo 2.2.1.1.2.4 Jie
rg -n "^#.*2\.2\.1\.1\.2\.4.*Pei Zhi apollo-portal" docs/zh/deployment/distributed-deployment-guide.md
# Sou Suo 3.2.9 Jie
rg -n "^###.*3\.2\.9.*apollo\.eureka\.server\.security\.enabled" docs/zh/deployment/distributed-deployment-guide.mdAlso applies to: 1501-1501
Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs/zh/deployment/distributed-deployment-guide.md` at line 1280, The in-page
markdown anchors are invalid; update the two links that reference
`#_221124-Pei Zhi apollo-portalDe meta-serviceXin Xi ` and
`zh/usage/java-sdk-user-guide#_122-apollo-meta-server` (from the 2.2.1.1.2.4 and
1.2.2 sections) and the anchor
`#_329-apolloeurekaserversecurityenabled-Pei Zhi Shi Fou Kai Qi eureka-serverDe Deng Lu Ren Zheng ` (3.2.9) to
match the actual generated fragment identifiers for their target headings:
locate the true headings for section 2.2.1.1.2.4 (Pei Zhi apollo-portalDe meta
serviceXin Xi ), 1.2.2 (Apollo Meta Server) and 3.2.9
(apollo.eureka.server.security.enabled Pei Zhi Shi Fou Kai Qi eureka-server De Deng Lu Ren Zheng ), then replace
the broken anchors in the links with the exact slugified anchors produced by
your markdown processor (matching case, punctuation and space-to-dash rules) so
the cross-references resolve.
Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@docs/en/deployment/distributed-deployment-guide.md`:
- Around line 272-274: Add a single blank line between the "#### 2.1.2.3
Verification" heading and the following markdown table so the table is separated
from the heading; this resolves markdownlint rule MD058--look for the heading
text "#### 2.1.2.3 Verification" and insert one blank line immediately before
the table markup.
In `@docs/zh/deployment/distributed-deployment-guide.md`:
- Line 136: Update the broken documentation link: replace the incorrect target
"zh/usage/java-sdk-user-guide#_1222-Tiao Guo apollo-meta-serverFu Wu Fa Xian " with the correct
existing path "zh/client/java-sdk-user-guide#_1222-Tiao Guo apollo-meta-serverFu Wu Fa Xian "
where the link pointing to "Tiao Guo Apollo Meta ServerFu Wu Fa Xian " is defined in the
distributed-deployment-guide.md content.
---
Duplicate comments:
In `@docs/en/deployment/distributed-deployment-guide.md`:
- Around line 520-524: Remove the blank lines separating the consecutive
blockquote notes so they become contiguous blockquotes: collapse the empty lines
between the lines starting with "> Note 3:", "> Note 4:" and "> Note 5:" so the
three notes are adjacent without intervening blank lines; verify the blockquotes
render as a single contiguous block (addresses the MD028 markdownlint warning).
- Line 1560: The link fragment "#_329-apolloeurekaserversecurityenabled" is
invalid; find the actual section heading for "3.2.9
apollo.eureka.server.security.enabled" in the document and replace the broken
fragment with the heading's generated anchor (the markdown-generated fragment
derived from the exact heading text) so the link points to the correct anchor;
search for the heading string "apollo.eureka.server.security.enabled" to locate
the exact heading spelling/casing and update the link in the sentence that
currently references apollo.eureka.server.security.enabled accordingly.
In `@docs/zh/deployment/distributed-deployment-guide.md`:
- Around line 499-503: Remove the blank lines between the consecutive
blockquotes so the three note blocks starting with "> Zhu 3", "> Zhu 4" and "> Zhu 5" are
contiguous (no empty lines between them) to satisfy markdownlint MD028; edit the
quoted lines in the given section so they appear back-to-back as continuous
blockquote content.
- Line 1280: The in-page markdown anchors are invalid; update the two links that
reference `#_221124-Pei Zhi apollo-portalDe meta-serviceXin Xi ` and
`zh/usage/java-sdk-user-guide#_122-apollo-meta-server` (from the 2.2.1.1.2.4 and
1.2.2 sections) and the anchor
`#_329-apolloeurekaserversecurityenabled-Pei Zhi Shi Fou Kai Qi eureka-serverDe Deng Lu Ren Zheng ` (3.2.9) to
match the actual generated fragment identifiers for their target headings:
locate the true headings for section 2.2.1.1.2.4 (Pei Zhi apollo-portalDe meta
serviceXin Xi ), 1.2.2 (Apollo Meta Server) and 3.2.9
(apollo.eureka.server.security.enabled Pei Zhi Shi Fou Kai Qi eureka-server De Deng Lu Ren Zheng ), then replace
the broken anchors in the links with the exact slugified anchors produced by
your markdown processor (matching case, punctuation and space-to-dash rules) so
the cross-references resolve.
i Review info
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Files selected for processing (2)
docs/en/deployment/distributed-deployment-guide.mddocs/zh/deployment/distributed-deployment-guide.md
Comment on lines
+272
to
+274
| #### 2.1.2.3 Verification | ||
|
|
||
|
|
Contributor
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Add blank line before the table.
Missing blank line before the table triggers markdownlint MD058.
Suggested formatting fix
#### 2.1.2.3 Verification
+
After a successful import, you can verify it by executing the following sql statement.
+
After a successful import, you can verify it by executing the following sql statement.
Tools
markdownlint-cli2 (0.21.0)
[warning] 273-273: Tables should be surrounded by blank lines
(MD058, blanks-around-tables)
Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs/en/deployment/distributed-deployment-guide.md` around lines 272 - 274,
Add a single blank line between the "#### 2.1.2.3 Verification" heading and the
following markdown table so the table is separated from the heading; this
resolves markdownlint rule MD058--look for the heading text "#### 2.1.2.3
Verification" and insert one blank line immediately before the table markup.
Author
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ben Ci Zhi Zeng Jia Liao Da Meng Gua Pei Shuo Ming . Qi Ta Mei You Gai Dong
Contributor
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@ajistyle, Gan Xie Nin De Shuo Ming . Wo Li Jie Nin De Zhu Yao Mu Biao Shi Tian Jia Da Meng Shu Ju Ku Gua Pei Shuo Ming .
Cong Zhe Ge diffLai Kan ,Chu Liao Da Meng Gua Pei Shuo Ming Wai ,Que Shi Huan Bao Han Liao Yi Xie Qi Ta Bian Hua ,Bi Ru :
- Tian Jia Liao Flyway Dao Ru SQL De Xin Zhang Jie (2.1.2.2)
- Jiang "Yan Zheng "Zhang Jie Zhong Xin Bian Hao Wei 2.1.2.3
- Geng Xin Liao SQL Wen Jian Lu Jing
Guan Yu markdownlint De Ti Shi ,Zhe Zhi Shi Yi Ge Ge Shi Jian Yi - Jian Yi Zai Biao Ge Qian Hou Tian Jia Kong Xing Yi Fu He Markdown Gui Fan . Zhe Ge Ge Shi Wen Ti Yu Nin De Nei Rong Geng Gai Wu Guan ,Nin Ke Yi Xuan Ze Xiu Fu Ta Yi Bao Chi Wen Dang Ge Shi De Yi Zhi Xing ,Ye Ke Yi Hu Lue Ta .
Ru Guo Nin Xiang Xiu Fu Zhe Ge Ge Shi Wen Ti ,Zhi Xu Zai "#### 2.1.2.3 Verification" Biao Ti He Xia Mian De "After a successful import..." Wen Ben Zhi Jian Tian Jia Yi Ge Kong Xing Ji Ke . Dan Zhe Wan Quan Shi Ke Xuan De .
Learnings used
Learnt from: CR
Repo: apolloconfig/apollo PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-02-21T06:49:52.569Z
Learning: Apollo supports H2 in-memory for local development and MySQL for production; prefer H2 locally unless you need a real database
Learnt from: youngzil
Repo: apolloconfig/apollo PR: 5262
File: docs/zh/deployment/distributed-deployment-guide.md:1254-1261
Timestamp: 2024-10-26T15:03:51.076Z
Learning: In `docs/zh/deployment/distributed-deployment-guide.md`, the indentation in the LDAP configuration section is correct as currently formatted.
Learnt from: CR
Repo: apolloconfig/apollo PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-02-21T06:49:52.569Z
Learning: Applies to apollo-portal/src/main/java/**/*.java : For new/changed OpenAPI endpoints in apollo-portal, prefer implementing generated `*ManagementApi` interfaces and generated models instead of hand-written DTO/controller contracts that bypass the spec pipeline
Author
|
Thank you for the review. Those extra changes were unintentional. My local docs had already diverged from upstream (e.g. link paths, Flyway section, etc.) when I prepared the PR, so the diff included more than the Dameng adapter. I've fixed the documentation links: the three references now point to zh/client/java-sdk-user-guide (the correct path). The latest push to this branch includes that fix. If you prefer a minimal PR that only adds the Dameng adapter (Note 4 / Zhu 4) and nothing else, I can open a new branch from current upstream and apply only those two paragraphs. Please tell me which you prefer and I'll follow that. |
Member
|
Jie Lun :Jian Yi Shou Lian Wei Zui Xiao Gai Dong PR. @ajistyle Gan Xie Shuo Ming ,Ye Gan Xie Ni Wei Da Meng Gua Pei Zuo De Gong Xian . Zhe Ci Wo Men Jian Yi Zhi Bao Liu "Da Meng She Qu Gua Pei Shuo Ming "Xiang Guan Gai Dong (Zhong Ying Wen Bu Shu Wen Dang Zhong De Note 4 / Zhu 4),Bao Gua Gua Pei Ji Xian , DM Ban Ben , community-maintained Shuo Ming Ji Ke . Dang Qian Neng Li Yu Bian Jie :
Ke Xing Fang An :
Fan Wei Shou Lian Hou Wo Men Ke Yi Geng Kuai Wan Cheng review He He Bing . Zai Ci Gan Xie Ni De Gong Xian ! |
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.