Skip to content

Fix broken links in generated property docs #6565

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.

Sign up for GitHub

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

Merged
DomGarguilo merged 1 commit into from
Sep 29, 2026
Merged

Fix broken links in generated property docs #6565

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions core/src/main/java/org/apache/accumulo/core/conf/ClientConfigGenerate.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,8 +95,8 @@ void pageHeader() {
doc.println("<!-- Generated by : " + getClass().getName() + " -->\n");
doc.println("Below are properties set in `accumulo-client.properties`"
+ " that configure [Accumulo clients]({{ page.docs_baseurl"
+ " }}/getting-started/clients#connecting). All properties have been part"
+ " of the API since 2.0.0 (unless otherwise specified):\n");
+ " }}/getting-started/clients#creating-an-accumulo-client). All properties have"
+ " been part of the API since 2.0.0 (unless otherwise specified):\n");
doc.println("| Property | Default value | Since | Description |");
doc.println("|----------|---------------|-------|-------------|");
}
Expand Down
8 changes: 6 additions & 2 deletions core/src/main/java/org/apache/accumulo/core/conf/ConfigurationDocGen.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,8 +88,12 @@ void prefixSection(Property prefix) {
if (depr) {
description += "*Deprecated since:* " + prefix.deprecatedSince() + "<br>";
if (prefix.isReplaced()) {
description += "*Replaced by:* <a href=\"#" + prefix.replacedBy().getKey().replace(".", "_")
+ "prefix\">" + prefix.replacedBy() + "</a><br>";
Property replacement = prefix.replacedBy();
String anchor = replacement.getKey().replace(".", "_");
if (replacement.getType() == PropertyType.PREFIX) {
anchor += "prefix";
}
description += "*Replaced by:* <a href=\"#" + anchor + "\">" + replacement + "</a><br>";
}
}
description += strike(sanitize(prefix.getDescription()), depr);
Expand Down
Loading