This is an automated email from the ASF dual-hosted git repository.
DomGarguilo pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/accumulo-website.git
The following commit(s) were added to refs/heads/main by this push:
new 2597c0099 Update generated docs build/copy steps in README (#486)
2597c0099 is described below
commit 2597c0099f9d10f631b79f2a9b7a789042f3315c
Author: Dom G. <[email protected]>
AuthorDate: Tue Aug 25 15:50:14 2026 -0400
Update generated docs build/copy steps in README (#486)
---
README.md | 10 ++++++----
1 file changed, 6 insertions(+), 4 deletions(-)
diff --git a/README.md b/README.md
index 21f18be1e..0ed389a2c 100644
--- a/README.md
+++ b/README.md
@@ -28,15 +28,17 @@ The source for these tags is at
[\_plugins/links.rb](_plugins/links.rb).
### Updating Property Documentation for Releases
-Building Accumulo generates `server-properties*.md` and
`client-properties*.md`.
-To regenerate these, do the following.
+Building Accumulo generates `server-properties*.md`, `client-properties*.md`,
and
+`metrics.md`. To regenerate these, do the following.
```bash
ACCUMULO_SITE_CLONE=<accumulo website clone location, with main branch checked
out>
-ACCUMULO_CLONE=<accumulo clone location>
+ACCUMULO_CLONE=<accumulo clone location, with the release tag checked out>
+# major version of that tag
+DOCS_VERSION=4
cd "$ACCUMULO_CLONE"
mvn package -DskipTests
-cp ./core/target/generated-docs/*.md
"$ACCUMULO_SITE_CLONE"/_docs-2/configuration/
+cp ./core/target/generated-docs/*.md
"$ACCUMULO_SITE_CLONE/_docs-$DOCS_VERSION/configuration/"
```
## Local Builds for Testing