DOC-908 | Release notes 3.11.14.4 and turn 3.11 into 3.11 (OEM LTS)#999
Open
Simran-B wants to merge 20 commits into
Open
DOC-908 | Release notes 3.11.14.4 and turn 3.11 into 3.11 (OEM LTS)#999Simran-B wants to merge 20 commits into
Simran-B wants to merge 20 commits into
Conversation
Contributor
|
Deploy Preview Available Via |
Contributor
📝 WalkthroughWalkthroughThis PR updates 3.11 OEM LTS documentation and metadata, adjusts template rendering for version labels, removes or narrows unsupported feature references, rewrites PERCENTILE docs, updates arangobackup examples, and refreshes CircleCI build-image tags. Changes3.11 version metadata, labels, and EOL messaging
Feature, deployment, and operations pruning
AQL and backup example updates
CI build config
Sequence Diagram(s)Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Possibly related PRs
Suggested labels
Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
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.
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (3)
site/content/arangodb/3.12/components/tools/arangobackup/examples.md (1)
285-297:⚠️ Potential issue | 🟡 Minor | ⚡ Quick winInconsistency: Second S3 example still includes
aclfield.The earlier example (line 150) removes the
aclfield with an accompanying info callout (lines 155-161) explaining that it should be omitted for AWS buckets with "Bucket owner enforced" ownership. However, this second S3 example still shows"acl": "private"on line 294, creating inconsistent guidance.Apply the same
aclremoval here to align with the earlier example and the documented AWS behavior.📝 Suggested fix
"my-s3": { "type": "s3", "provider": "aws", "env_auth": "false", "access_key_id": "XXXXXXXXXXXXXXXXXXXX", "secret_access_key": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", - "region": "xx-xxxx-x", - "acl": "private" + "region": "xx-xxxx-x" }🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@site/content/arangodb/3.12/components/tools/arangobackup/examples.md` around lines 285 - 297, The second S3 JSON example's "my-s3" object still includes the "acl": "private" entry which contradicts the earlier example and guidance; remove the "acl" field from the "my-s3" object in that example so it matches the earlier S3 example and the documented AWS "Bucket owner enforced" recommendation, leaving the other keys (type, provider, env_auth, access_key_id, secret_access_key, region) unchanged.site/content/arangodb/3.11/components/tools/arangobackup/examples.md (1)
287-299:⚠️ Potential issue | 🟡 Minor | ⚡ Quick winInconsistency: Second S3 example still includes
aclfield.The earlier example (line 152) removes the
aclfield with an accompanying info callout (lines 157-163) explaining that it should be omitted for AWS buckets with "Bucket owner enforced" ownership. However, this second S3 example still shows"acl": "private"on line 296, creating inconsistent guidance.Apply the same
aclremoval here to align with the earlier example and the documented AWS behavior.📝 Suggested fix
"my-s3": { "type": "s3", "provider": "aws", "env_auth": "false", "access_key_id": "XXXXXXXXXXXXXXXXXXXX", "secret_access_key": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", - "region": "xx-xxxx-x", - "acl": "private" + "region": "xx-xxxx-x" }🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@site/content/arangodb/3.11/components/tools/arangobackup/examples.md` around lines 287 - 299, The JSON S3 example for "my-s3" still contains the "acl": "private" entry which contradicts the earlier example and callout; remove the "acl" field from the "my-s3" object (the example with "type": "s3" and "provider": "aws") so the snippet matches the earlier example and documented AWS "Bucket owner enforced" guidance, and verify any surrounding explanatory text references the omission consistently.site/content/arangodb/4.0/components/tools/arangobackup/examples.md (1)
285-297:⚠️ Potential issue | 🟡 Minor | ⚡ Quick winInconsistency: Second S3 example still includes
aclfield.The earlier example (line 150) removes the
aclfield with an accompanying info callout (lines 155-161) explaining that it should be omitted for AWS buckets with "Bucket owner enforced" ownership. However, this second S3 example still shows"acl": "private"on line 294, creating inconsistent guidance.Apply the same
aclremoval here to align with the earlier example and the documented AWS behavior.📝 Suggested fix
"my-s3": { "type": "s3", "provider": "aws", "env_auth": "false", "access_key_id": "XXXXXXXXXXXXXXXXXXXX", "secret_access_key": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", - "region": "xx-xxxx-x", - "acl": "private" + "region": "xx-xxxx-x" }🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@site/content/arangodb/4.0/components/tools/arangobackup/examples.md` around lines 285 - 297, Remove the ACL field from the second S3 example's "my-s3" configuration to match the earlier example and AWS "Bucket owner enforced" guidance: locate the JSON object keyed "my-s3" in the examples and delete the "acl": "private" entry so the example omits the acl attribute entirely, ensuring consistency with the first S3 example and the surrounding documentation.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Outside diff comments:
In `@site/content/arangodb/3.11/components/tools/arangobackup/examples.md`:
- Around line 287-299: The JSON S3 example for "my-s3" still contains the "acl":
"private" entry which contradicts the earlier example and callout; remove the
"acl" field from the "my-s3" object (the example with "type": "s3" and
"provider": "aws") so the snippet matches the earlier example and documented AWS
"Bucket owner enforced" guidance, and verify any surrounding explanatory text
references the omission consistently.
In `@site/content/arangodb/3.12/components/tools/arangobackup/examples.md`:
- Around line 285-297: The second S3 JSON example's "my-s3" object still
includes the "acl": "private" entry which contradicts the earlier example and
guidance; remove the "acl" field from the "my-s3" object in that example so it
matches the earlier S3 example and the documented AWS "Bucket owner enforced"
recommendation, leaving the other keys (type, provider, env_auth, access_key_id,
secret_access_key, region) unchanged.
In `@site/content/arangodb/4.0/components/tools/arangobackup/examples.md`:
- Around line 285-297: Remove the ACL field from the second S3 example's "my-s3"
configuration to match the earlier example and AWS "Bucket owner enforced"
guidance: locate the JSON object keyed "my-s3" in the examples and delete the
"acl": "private" entry so the example omits the acl attribute entirely, ensuring
consistency with the first S3 example and the surrounding documentation.
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 7608987c-2542-426e-b5db-7248dfc775ae
📒 Files selected for processing (14)
site/content/arangodb/3.11/_index.mdsite/content/arangodb/3.11/components/tools/arangobackup/examples.mdsite/content/arangodb/3.11/features/_index.mdsite/content/arangodb/3.11/release-notes/version-3.11/api-changes-in-3-11.mdsite/content/arangodb/3.11/release-notes/version-3.11/whats-new-in-3-11.mdsite/content/arangodb/3.12/components/tools/arangobackup/examples.mdsite/content/arangodb/3.12/release-notes/version-3.11/api-changes-in-3-11.mdsite/content/arangodb/3.12/release-notes/version-3.11/whats-new-in-3-11.mdsite/content/arangodb/4.0/components/tools/arangobackup/examples.mdsite/content/arangodb/4.0/release-notes/version-3.11/api-changes-in-3-11.mdsite/content/arangodb/4.0/release-notes/version-3.11/whats-new-in-3-11.mdsite/data/versions.yamlsite/themes/arangodb-docs-theme/layouts/partials/breadcrumbs.htmlsite/themes/arangodb-docs-theme/layouts/partials/version-selector.html
…RCENTILE() numeric AQL function (#875)
5 tasks
Contributor
There was a problem hiding this comment.
Actionable comments posted: 4
🧹 Nitpick comments (3)
site/content/arangodb/3.11/operations/upgrading/downgrading.md (1)
49-51: ⚡ Quick winClarify the subject in the Cluster prerequisite sentence.
Line 50 uses “stopped them”, which is ambiguous in a procedural step. Please explicitly name the target processes to avoid operator misread.
Proposed wording
-stopped the ArangoDB process running on it) before the upgrade. If you are running -a Cluster, this procedure assumes that you have stopped them before +stopped the ArangoDB process running on it) before the upgrade. If you are running +a Cluster, this procedure assumes that you have stopped all cluster processes before the upgrade, and that you have taken a copy of their data directories, from all involved machines.🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@site/content/arangodb/3.11/operations/upgrading/downgrading.md` around lines 49 - 51, Replace the ambiguous pronoun "stopped them" in the sentence that begins "If you are running a Cluster, this procedure assumes that you have stopped them before the upgrade" with an explicit list of the processes to stop (for example: "stopped all ArangoDB server processes on those nodes (coordinators and DB-servers)" or "stopped the coordinator and DB-Server processes on each cluster node") so the prerequisite clearly names the target processes and avoids operator confusion.site/content/arangodb/3.11/deploy/architecture/replication.md (1)
16-16: 💤 Low valueConsider hyphenating compound adjective.
The phrase "mission critical" should be hyphenated when used as a compound adjective before a noun: "mission-critical data".
✏️ Suggested fix
-Synchronous replication is typically used for mission critical data which must be +Synchronous replication is typically used for mission-critical data which must be🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@site/content/arangodb/3.11/deploy/architecture/replication.md` at line 16, Update the sentence containing the phrase "Synchronous replication is typically used for mission critical data which must be" to hyphenate the compound adjective by replacing "mission critical data" with "mission-critical data"; locate the exact string "Synchronous replication is typically used for mission critical data which must be" in the replication.md content and apply the hyphenation change to ensure correct compound-adjective formatting.site/content/arangodb/3.12/release-notes/version-3.11/api-changes-in-3-11.md (1)
823-824: 💤 Low valueConsider clarifying the deprecation timeline.
The wording "unsupported in the 3.11 OEM LTS version" could be more precise. Since the section header states "Deprecated in: v3.11.14-1", consider making the relationship explicit to avoid ambiguity about when the endpoints become unsupported.
Suggested wording improvement
-The `/_api/control_pregel/*` endpoints are unsupported in the 3.11 OEM LTS version -and removed in v3.12.0 as Pregel graph processing is no longer supported. +The `/_api/control_pregel/*` endpoints are unsupported starting from v3.11.14-1 +in the 3.11 OEM LTS version and removed in v3.12.0 as Pregel graph processing +is no longer supported.🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@site/content/arangodb/3.12/release-notes/version-3.11/api-changes-in-3-11.md` around lines 823 - 824, The sentence about `/_api/control_pregel/*` is ambiguous about when support ends; update the text to explicitly state that these endpoints were deprecated in v3.11.14-1 (as shown by the "Deprecated in: v3.11.14-1" header) became unsupported in the OEM LTS 3.11.14-1 release, and were removed in v3.12.0, so readers clearly understand the deprecation and removal timeline for `/_api/control_pregel/*`.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In
`@site/content/arangodb/3.11/components/tools/arangodb-starter/architecture.md`:
- Around line 47-50: The deployment modes list currently enumerates "Single
server" and "Cluster" but later text still references "activefailover"; update
the section so it stays consistent by adding "Active failover (activefailover)"
to the bullet list OR remove/adjust the later `activefailover` sections to match
only "Single server" and "Cluster". Make the change in the same "Starter
supports different modes" paragraph and ensure any cross-references to
`activefailover` elsewhere in the document are updated to reflect the chosen set
of supported modes.
- Line 14: Update the text fragment that currently reads "to a full blown
Cluster in under 5 minutes." to use correct hyphenation: replace "full blown"
with "full-blown" so the sentence reads "to a full-blown Cluster in under 5
minutes." Locate and edit the string containing "full blown Cluster" in the
document (the exact phrase shown in the diff) and apply the hyphenation change.
In `@site/content/arangodb/3.11/operations/backup-and-restore.md`:
- Around line 32-33: Replace the ungrammatical warning sentence "Making use of a
high availability deployment modes of ArangoDB does not remove the need of" with
a corrected phrase such as "Using high-availability deployment modes of ArangoDB
does not remove the need for" or "Using high-availability deployment modes of
ArangoDB does not eliminate the need for" so that "high-availability" is
hyphenated, "modes" agrees with the plural form, and the preposition is
corrected to "for".
In `@site/content/arangodb/3.11/operations/security/change-root-password.md`:
- Line 37: The two sentences conflict: clarify that for ArangoDB Cluster you
must disable/enable authentication by editing the arangod.conf on each
individual node (e.g., the node-specific arangod.conf file), and remove or
rephrase the assertion that edits to etc/arangodb3/arangod.conf “will not work”
so it instead states that editing a single central path is
insufficient—explicitly instruct operators to apply the change to every node’s
arangod.conf (and restart or reload each node as appropriate) and replace the
existing contradictory lines referencing `arangod.conf` and
`etc/arangodb3/arangod.conf` with this single clear instruction.
---
Nitpick comments:
In `@site/content/arangodb/3.11/deploy/architecture/replication.md`:
- Line 16: Update the sentence containing the phrase "Synchronous replication is
typically used for mission critical data which must be" to hyphenate the
compound adjective by replacing "mission critical data" with "mission-critical
data"; locate the exact string "Synchronous replication is typically used for
mission critical data which must be" in the replication.md content and apply the
hyphenation change to ensure correct compound-adjective formatting.
In `@site/content/arangodb/3.11/operations/upgrading/downgrading.md`:
- Around line 49-51: Replace the ambiguous pronoun "stopped them" in the
sentence that begins "If you are running a Cluster, this procedure assumes that
you have stopped them before the upgrade" with an explicit list of the processes
to stop (for example: "stopped all ArangoDB server processes on those nodes
(coordinators and DB-servers)" or "stopped the coordinator and DB-Server
processes on each cluster node") so the prerequisite clearly names the target
processes and avoids operator confusion.
In
`@site/content/arangodb/3.12/release-notes/version-3.11/api-changes-in-3-11.md`:
- Around line 823-824: The sentence about `/_api/control_pregel/*` is ambiguous
about when support ends; update the text to explicitly state that these
endpoints were deprecated in v3.11.14-1 (as shown by the "Deprecated in:
v3.11.14-1" header) became unsupported in the OEM LTS 3.11.14-1 release, and
were removed in v3.12.0, so readers clearly understand the deprecation and
removal timeline for `/_api/control_pregel/*`.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 2b8353de-40ec-4528-a4c8-110501574c4e
📒 Files selected for processing (108)
.circleci/generate_config.pysite/content/arangodb/3.10/develop/drivers/java/reference-version-7/driver-setup.mdsite/content/arangodb/3.10/operations/upgrading/os-specific-information/macos.mdsite/content/arangodb/3.11/aql/functions/miscellaneous.mdsite/content/arangodb/3.11/aql/functions/numeric.mdsite/content/arangodb/3.11/components/arangodb-server/_index.mdsite/content/arangodb/3.11/components/arangodb-server/ldap.mdsite/content/arangodb/3.11/components/tools/arangobackup/_index.mdsite/content/arangodb/3.11/components/tools/arangobackup/examples.mdsite/content/arangodb/3.11/components/tools/arangodb-starter/architecture.mdsite/content/arangodb/3.11/components/tools/arangodb-starter/options.mdsite/content/arangodb/3.11/components/tools/arangodb-starter/security.mdsite/content/arangodb/3.11/components/tools/arangodump/_index.mdsite/content/arangodb/3.11/components/tools/arangodump/limitations.mdsite/content/arangodb/3.11/concepts/data-models.mdsite/content/arangodb/3.11/concepts/data-structure/collections.mdsite/content/arangodb/3.11/concepts/data-structure/databases.mdsite/content/arangodb/3.11/concepts/data-structure/documents/computed-values.mdsite/content/arangodb/3.11/concepts/data-structure/views.mdsite/content/arangodb/3.11/data-science/pregel/_index.mdsite/content/arangodb/3.11/data-science/pregel/algorithms.mdsite/content/arangodb/3.11/deploy/_index.mdsite/content/arangodb/3.11/deploy/active-failover/_index.mdsite/content/arangodb/3.11/deploy/active-failover/administration.mdsite/content/arangodb/3.11/deploy/active-failover/manual-start.mdsite/content/arangodb/3.11/deploy/active-failover/using-the-arangodb-starter.mdsite/content/arangodb/3.11/deploy/arangosync/_index.mdsite/content/arangodb/3.11/deploy/arangosync/administration.mdsite/content/arangodb/3.11/deploy/arangosync/deployment/_index.mdsite/content/arangodb/3.11/deploy/arangosync/deployment/arangodb-cluster.mdsite/content/arangodb/3.11/deploy/arangosync/deployment/arangosync-master.mdsite/content/arangodb/3.11/deploy/arangosync/deployment/arangosync-workers.mdsite/content/arangodb/3.11/deploy/arangosync/deployment/prometheus-and-grafana.mdsite/content/arangodb/3.11/deploy/arangosync/monitoring.mdsite/content/arangodb/3.11/deploy/arangosync/operations-and-maintenance.mdsite/content/arangodb/3.11/deploy/arangosync/security.mdsite/content/arangodb/3.11/deploy/arangosync/troubleshooting.mdsite/content/arangodb/3.11/deploy/architecture/data-sharding.mdsite/content/arangodb/3.11/deploy/architecture/replication.mdsite/content/arangodb/3.11/deploy/cluster/_index.mdsite/content/arangodb/3.11/deploy/kubernetes.mdsite/content/arangodb/3.11/deploy/single-instance/_index.mdsite/content/arangodb/3.11/develop/http-api/administration.mdsite/content/arangodb/3.11/develop/http-api/documents.mdsite/content/arangodb/3.11/develop/http-api/pregel.mdsite/content/arangodb/3.11/develop/javascript-api/_index.mdsite/content/arangodb/3.11/features/_index.mdsite/content/arangodb/3.11/features/enterprise-edition.mdsite/content/arangodb/3.11/features/highlights-by-version.mdsite/content/arangodb/3.11/features/list.mdsite/content/arangodb/3.11/get-started/_index.mdsite/content/arangodb/3.11/get-started/how-to-interact-with-arangodb.mdsite/content/arangodb/3.11/get-started/set-up-a-cloud-instance.mdsite/content/arangodb/3.11/graphs/_index.mdsite/content/arangodb/3.11/graphs/example-graphs.mdsite/content/arangodb/3.11/operations/administration/_index.mdsite/content/arangodb/3.11/operations/administration/telemetrics.mdsite/content/arangodb/3.11/operations/administration/user-management/_index.mdsite/content/arangodb/3.11/operations/backup-and-restore.mdsite/content/arangodb/3.11/operations/installation/_index.mdsite/content/arangodb/3.11/operations/installation/compiling/_index.mdsite/content/arangodb/3.11/operations/installation/compiling/compile-on-debian.mdsite/content/arangodb/3.11/operations/installation/compiling/compile-on-windows.mdsite/content/arangodb/3.11/operations/installation/compiling/recompiling-jemalloc.mdsite/content/arangodb/3.11/operations/installation/compiling/running-custom-build.mdsite/content/arangodb/3.11/operations/installation/docker.mdsite/content/arangodb/3.11/operations/installation/linux/_index.mdsite/content/arangodb/3.11/operations/installation/macos.mdsite/content/arangodb/3.11/operations/installation/windows.mdsite/content/arangodb/3.11/operations/security/change-root-password.mdsite/content/arangodb/3.11/operations/upgrading/_index.mdsite/content/arangodb/3.11/operations/upgrading/community-to-enterprise-upgrade.mdsite/content/arangodb/3.11/operations/upgrading/downgrading.mdsite/content/arangodb/3.11/operations/upgrading/manual-deployments/active-failover.mdsite/content/arangodb/3.11/operations/upgrading/os-specific-information/linux.mdsite/content/arangodb/3.11/operations/upgrading/os-specific-information/macos.mdsite/content/arangodb/3.11/operations/upgrading/starter-deployments.mdsite/content/arangodb/3.11/release-notes/deprecated-and-removed-features.mdsite/content/arangodb/3.11/release-notes/version-3.10/api-changes-in-3-10.mdsite/content/arangodb/3.11/release-notes/version-3.11/api-changes-in-3-11.mdsite/content/arangodb/3.11/release-notes/version-3.11/incompatible-changes-in-3-11.mdsite/content/arangodb/3.11/release-notes/version-3.11/known-issues-in-3-11.mdsite/content/arangodb/3.11/release-notes/version-3.11/whats-new-in-3-11.mdsite/content/arangodb/3.11/release-notes/version-3.2/whats-new-in-3-2.mdsite/content/arangodb/3.11/release-notes/version-3.3/whats-new-in-3-3.mdsite/content/arangodb/3.11/release-notes/version-3.4/whats-new-in-3-4.mdsite/content/arangodb/3.11/release-notes/version-3.5/known-issues-in-3-5.mdsite/content/arangodb/3.11/release-notes/version-3.7/whats-new-in-3-7.mdsite/content/arangodb/3.12/components/tools/arangobackup/examples.mdsite/content/arangodb/3.12/features/list.mdsite/content/arangodb/3.12/release-notes/deprecated-and-removed-features.mdsite/content/arangodb/3.12/release-notes/version-3.11/api-changes-in-3-11.mdsite/content/arangodb/3.12/release-notes/version-3.11/incompatible-changes-in-3-11.mdsite/content/arangodb/3.12/release-notes/version-3.11/known-issues-in-3-11.mdsite/content/arangodb/3.12/release-notes/version-3.11/whats-new-in-3-11.mdsite/content/arangodb/3.12/release-notes/version-3.12/incompatible-changes-in-3-12.mdsite/content/arangodb/4.0/components/tools/arangobackup/examples.mdsite/content/arangodb/4.0/features/list.mdsite/content/arangodb/4.0/release-notes/deprecated-and-removed-features.mdsite/content/arangodb/4.0/release-notes/version-3.11/api-changes-in-3-11.mdsite/content/arangodb/4.0/release-notes/version-3.11/incompatible-changes-in-3-11.mdsite/content/arangodb/4.0/release-notes/version-3.11/known-issues-in-3-11.mdsite/content/arangodb/4.0/release-notes/version-3.11/whats-new-in-3-11.mdsite/content/arangodb/4.0/release-notes/version-3.12/incompatible-changes-in-3-12.mdsite/content/ecosystem/drivers/java/reference-version-7/driver-setup.mdsite/content/ecosystem/integrations/arangodb-datasource-for-apache-spark.mdsite/themes/arangodb-docs-theme/layouts/partials/breadcrumbs.htmlsite/themes/arangodb-docs-theme/layouts/partials/version-selector.html
💤 Files with no reviewable changes (42)
- site/content/arangodb/3.11/deploy/arangosync/operations-and-maintenance.md
- site/content/arangodb/3.11/deploy/arangosync/administration.md
- site/content/arangodb/3.11/deploy/arangosync/deployment/prometheus-and-grafana.md
- site/content/arangodb/3.11/deploy/arangosync/_index.md
- site/content/arangodb/3.11/deploy/active-failover/administration.md
- site/content/arangodb/3.11/features/enterprise-edition.md
- site/content/arangodb/3.11/deploy/active-failover/_index.md
- site/content/arangodb/3.11/operations/installation/compiling/recompiling-jemalloc.md
- site/content/arangodb/3.11/components/arangodb-server/ldap.md
- site/content/arangodb/3.11/operations/upgrading/manual-deployments/active-failover.md
- site/content/arangodb/3.11/deploy/arangosync/deployment/_index.md
- site/content/arangodb/3.11/deploy/arangosync/security.md
- site/content/arangodb/3.11/operations/installation/docker.md
- site/content/arangodb/3.11/deploy/arangosync/deployment/arangosync-master.md
- site/content/arangodb/3.11/release-notes/version-3.7/whats-new-in-3-7.md
- site/content/arangodb/3.11/deploy/arangosync/deployment/arangodb-cluster.md
- site/content/arangodb/3.11/get-started/set-up-a-cloud-instance.md
- site/content/arangodb/3.11/operations/installation/compiling/compile-on-debian.md
- site/content/arangodb/3.11/operations/installation/compiling/_index.md
- site/content/arangodb/3.11/deploy/arangosync/troubleshooting.md
- site/content/arangodb/3.11/deploy/active-failover/using-the-arangodb-starter.md
- site/content/arangodb/3.11/data-science/pregel/algorithms.md
- site/content/arangodb/3.11/develop/javascript-api/_index.md
- site/content/arangodb/3.11/operations/installation/compiling/running-custom-build.md
- site/content/arangodb/3.11/deploy/arangosync/deployment/arangosync-workers.md
- site/content/arangodb/3.11/develop/http-api/pregel.md
- site/content/arangodb/3.11/operations/installation/compiling/compile-on-windows.md
- site/content/arangodb/3.11/deploy/kubernetes.md
- site/content/arangodb/3.11/deploy/active-failover/manual-start.md
- site/content/arangodb/3.11/release-notes/version-3.3/whats-new-in-3-3.md
- site/content/arangodb/3.11/data-science/pregel/_index.md
- site/content/arangodb/3.11/aql/functions/miscellaneous.md
- site/content/arangodb/3.11/deploy/arangosync/monitoring.md
- site/content/arangodb/3.11/operations/administration/user-management/_index.md
- site/content/arangodb/3.11/release-notes/version-3.5/known-issues-in-3-5.md
- site/content/arangodb/3.11/develop/http-api/documents.md
- site/content/arangodb/4.0/release-notes/version-3.11/known-issues-in-3-11.md
- site/content/arangodb/3.11/release-notes/version-3.11/known-issues-in-3-11.md
- site/content/arangodb/3.11/components/tools/arangodb-starter/options.md
- site/content/arangodb/3.12/release-notes/version-3.11/known-issues-in-3-11.md
- site/content/arangodb/3.11/release-notes/version-3.4/whats-new-in-3-4.md
- site/content/arangodb/3.11/release-notes/version-3.10/api-changes-in-3-10.md
✅ Files skipped from review due to trivial changes (39)
- site/content/arangodb/3.11/components/arangodb-server/_index.md
- site/content/arangodb/3.11/components/tools/arangodump/limitations.md
- site/content/arangodb/3.11/deploy/single-instance/_index.md
- site/content/arangodb/3.12/features/list.md
- site/content/arangodb/4.0/features/list.md
- site/content/arangodb/3.11/components/tools/arangobackup/_index.md
- site/content/arangodb/3.11/graphs/example-graphs.md
- site/content/arangodb/3.11/concepts/data-structure/documents/computed-values.md
- site/content/arangodb/3.11/components/tools/arangodb-starter/security.md
- site/content/arangodb/3.11/release-notes/version-3.2/whats-new-in-3-2.md
- site/content/arangodb/3.11/operations/installation/windows.md
- site/content/arangodb/3.10/develop/drivers/java/reference-version-7/driver-setup.md
- site/content/ecosystem/drivers/java/reference-version-7/driver-setup.md
- site/content/arangodb/3.11/operations/upgrading/os-specific-information/linux.md
- site/content/arangodb/3.11/operations/administration/telemetrics.md
- site/content/arangodb/3.11/operations/installation/linux/_index.md
- site/content/arangodb/3.11/concepts/data-structure/collections.md
- site/content/arangodb/3.11/get-started/how-to-interact-with-arangodb.md
- site/content/arangodb/3.11/components/tools/arangodump/_index.md
- site/content/arangodb/3.11/deploy/architecture/data-sharding.md
- site/content/arangodb/3.10/operations/upgrading/os-specific-information/macos.md
- site/content/arangodb/3.11/operations/upgrading/os-specific-information/macos.md
- site/content/arangodb/3.11/concepts/data-structure/databases.md
- site/content/arangodb/3.11/get-started/_index.md
- site/content/arangodb/4.0/release-notes/version-3.11/whats-new-in-3-11.md
- site/content/arangodb/3.11/develop/http-api/administration.md
- site/content/arangodb/4.0/release-notes/deprecated-and-removed-features.md
- site/content/arangodb/3.11/release-notes/deprecated-and-removed-features.md
- site/content/arangodb/3.11/concepts/data-structure/views.md
- site/content/ecosystem/integrations/arangodb-datasource-for-apache-spark.md
- site/content/arangodb/3.12/release-notes/version-3.12/incompatible-changes-in-3-12.md
- site/content/arangodb/4.0/release-notes/version-3.12/incompatible-changes-in-3-12.md
- site/content/arangodb/3.11/operations/upgrading/_index.md
- site/content/arangodb/3.11/operations/upgrading/starter-deployments.md
- site/content/arangodb/4.0/release-notes/version-3.11/api-changes-in-3-11.md
- site/content/arangodb/3.11/components/tools/arangobackup/examples.md
- site/content/arangodb/3.12/release-notes/deprecated-and-removed-features.md
- site/content/arangodb/4.0/components/tools/arangobackup/examples.md
- site/content/arangodb/3.11/deploy/cluster/_index.md
🚧 Files skipped from review as they are similar to previous changes (4)
- site/themes/arangodb-docs-theme/layouts/partials/version-selector.html
- site/content/arangodb/3.12/components/tools/arangobackup/examples.md
- site/themes/arangodb-docs-theme/layouts/partials/breadcrumbs.html
- site/content/arangodb/3.12/release-notes/version-3.11/whats-new-in-3-11.md
Contributor
There was a problem hiding this comment.
Actionable comments posted: 2
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
site/content/arangodb/3.11/components/tools/arangodb-starter/options.md (1)
193-194:⚠️ Potential issue | 🟡 Minor | ⚡ Quick winRewrite this sentence for clarity and correctness.
Current wording is ungrammatical and repeats “by default,” which makes the behavior unclear.
✏️ Suggested edit
-Environment variables by default gonna be passed from arangodb process by -default. However, variables can be overridden using arangodb command line option. +By default, environment variables from the `arangodb` process are passed through. +You can override them using `arangodb` command-line options.🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@site/content/arangodb/3.11/components/tools/arangodb-starter/options.md` around lines 193 - 194, Rewrite the ungrammatical sentence "Environment variables by default gonna be passed from arangodb process by default. However, variables can be overridden using arangadb command line option." to a clear, correct sentence that removes the duplicated "by default" and corrects grammar; for example, replace that line with a single sentence stating that environment variables are inherited from the arangodb process but can be overridden using the arangadb command-line option (keep the reference to "environment variables" and "arangadb command line option").
♻️ Duplicate comments (1)
site/content/arangodb/3.11/operations/security/change-root-password.md (1)
37-38:⚠️ Potential issue | 🟠 Major | ⚡ Quick winConflicting cluster instruction still needs consolidation
This is still contradictory: it says to update each node’s
arangod.conf, then says updates toetc/arangodb3/arangod.confwon’t work. Please replace both lines (and remove the TODO) with one clear instruction: apply auth toggle on each node’s effectivearangodconfig source for that deployment method.🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@site/content/arangodb/3.11/operations/security/change-root-password.md` around lines 37 - 38, Replace the two conflicting sentences and the TODO with a single clear instruction: tell the user to toggle authentication in each node's effective arangod configuration source (referencing arangod.conf and not assuming the path /etc/arangodb3/arangod.conf is valid for all deployment types), i.e., state "For Cluster deployments, disable/enable authentication on each node by updating that node's effective arangod configuration source (the arangod.conf used by that deployment method) rather than assuming a fixed path such as /etc/arangodb3/arangod.conf." Ensure the updated text mentions "Cluster" and references arangod.conf and /etc/arangodb3/arangod.conf so readers understand why the fixed path may not apply.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In
`@site/content/arangodb/4.0/release-notes/version-3.11/incompatible-changes-in-3-11.md`:
- Around line 642-647: The version tag text is inconsistent with the heading "##
LDAP authentication unsupported"; update the small tag that currently reads
"Deprecated in: v3.11.14-1" to instead read "Unsupported in: v3.11.14-1" so the
version tag matches the statement in the heading and body (locate the small tag
near the "LDAP authentication unsupported" heading in the file and replace the
word "Deprecated" with "Unsupported").
- Around line 625-640: The version tag wording is inconsistent with the heading
"Pregel unsupported"—replace the small tag text `Deprecated in: v3.11.14-1` with
`Unsupported in: v3.11.14-1` (or `Removed in: v3.11.14-1` if removal is
intended) so the <small> tag matches the "Pregel unsupported" heading and the
list describing unavailable functionality; update the `<small>` tag content
accordingly.
---
Outside diff comments:
In `@site/content/arangodb/3.11/components/tools/arangodb-starter/options.md`:
- Around line 193-194: Rewrite the ungrammatical sentence "Environment variables
by default gonna be passed from arangodb process by default. However, variables
can be overridden using arangadb command line option." to a clear, correct
sentence that removes the duplicated "by default" and corrects grammar; for
example, replace that line with a single sentence stating that environment
variables are inherited from the arangodb process but can be overridden using
the arangadb command-line option (keep the reference to "environment variables"
and "arangadb command line option").
---
Duplicate comments:
In `@site/content/arangodb/3.11/operations/security/change-root-password.md`:
- Around line 37-38: Replace the two conflicting sentences and the TODO with a
single clear instruction: tell the user to toggle authentication in each node's
effective arangod configuration source (referencing arangod.conf and not
assuming the path /etc/arangodb3/arangod.conf is valid for all deployment
types), i.e., state "For Cluster deployments, disable/enable authentication on
each node by updating that node's effective arangod configuration source (the
arangod.conf used by that deployment method) rather than assuming a fixed path
such as /etc/arangodb3/arangod.conf." Ensure the updated text mentions "Cluster"
and references arangod.conf and /etc/arangodb3/arangod.conf so readers
understand why the fixed path may not apply.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: b365b212-cdde-41be-8068-8887d62502b9
📒 Files selected for processing (19)
site/content/arangodb/3.11/components/tools/arangodb-starter/architecture.mdsite/content/arangodb/3.11/components/tools/arangodb-starter/options.mdsite/content/arangodb/3.11/deploy/architecture/replication.mdsite/content/arangodb/3.11/operations/security/change-root-password.mdsite/content/arangodb/3.11/operations/upgrading/downgrading.mdsite/content/arangodb/3.11/operations/upgrading/starter-deployments.mdsite/content/arangodb/3.11/release-notes/version-3.11/api-changes-in-3-11.mdsite/content/arangodb/3.11/release-notes/version-3.11/incompatible-changes-in-3-11.mdsite/content/arangodb/3.12/components/tools/arangodb-starter/architecture.mdsite/content/arangodb/3.12/deploy/architecture/replication.mdsite/content/arangodb/3.12/operations/security/change-root-password.mdsite/content/arangodb/3.12/operations/upgrading/downgrading.mdsite/content/arangodb/3.12/release-notes/version-3.11/api-changes-in-3-11.mdsite/content/arangodb/3.12/release-notes/version-3.11/incompatible-changes-in-3-11.mdsite/content/arangodb/4.0/components/tools/arangodb-starter/architecture.mdsite/content/arangodb/4.0/deploy/architecture/replication.mdsite/content/arangodb/4.0/operations/upgrading/downgrading.mdsite/content/arangodb/4.0/release-notes/version-3.11/api-changes-in-3-11.mdsite/content/arangodb/4.0/release-notes/version-3.11/incompatible-changes-in-3-11.md
✅ Files skipped from review due to trivial changes (9)
- site/content/arangodb/3.12/operations/security/change-root-password.md
- site/content/arangodb/3.12/operations/upgrading/downgrading.md
- site/content/arangodb/4.0/components/tools/arangodb-starter/architecture.md
- site/content/arangodb/3.12/deploy/architecture/replication.md
- site/content/arangodb/4.0/deploy/architecture/replication.md
- site/content/arangodb/3.12/components/tools/arangodb-starter/architecture.md
- site/content/arangodb/4.0/operations/upgrading/downgrading.md
- site/content/arangodb/3.11/operations/upgrading/downgrading.md
- site/content/arangodb/3.11/deploy/architecture/replication.md
🚧 Files skipped from review as they are similar to previous changes (2)
- site/content/arangodb/3.12/release-notes/version-3.11/incompatible-changes-in-3-11.md
- site/content/arangodb/3.11/release-notes/version-3.11/incompatible-changes-in-3-11.md
Contributor
There was a problem hiding this comment.
🧹 Nitpick comments (1)
.circleci/generate_config.py (1)
99-100: 📐 Maintainability & Code Quality | 🔵 Trivial | ⚡ Quick winExtract the 3.10/3.11 nightly-skip rule into one helper.
This availability rule now lives in three places, so the next policy change can easily update compile and launch paths inconsistently.
Also applies to: 189-190, 307-308
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In @.circleci/generate_config.py around lines 99 - 100, The 3.10/3.11 nightly-skip availability rule is duplicated across the config generation paths, so extract it into one shared helper and use that everywhere. Add a helper near the existing logic in generate_config.py to encapsulate the version/workflow skip check, then replace the inline checks in the generation/compile/launch branches with that helper so policy changes stay consistent.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Nitpick comments:
In @.circleci/generate_config.py:
- Around line 99-100: The 3.10/3.11 nightly-skip availability rule is duplicated
across the config generation paths, so extract it into one shared helper and use
that everywhere. Add a helper near the existing logic in generate_config.py to
encapsulate the version/workflow skip check, then replace the inline checks in
the generation/compile/launch branches with that helper so policy changes stay
consistent.
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: abaf03a8-9753-4f7e-ac6a-71bf413c5bbb
📒 Files selected for processing (12)
.circleci/generate_config.pysite/content/arangodb/3.11/features/highlights-by-version.mdsite/content/arangodb/3.11/features/list.mdsite/content/arangodb/3.11/operations/backup-and-restore.mdsite/content/arangodb/3.12/features/list.mdsite/content/arangodb/3.12/operations/backup-and-restore.mdsite/content/arangodb/3.12/release-notes/deprecated-and-removed-features.mdsite/content/arangodb/3.12/release-notes/version-3.12/incompatible-changes-in-3-12.mdsite/content/arangodb/4.0/features/list.mdsite/content/arangodb/4.0/operations/backup-and-restore.mdsite/content/arangodb/4.0/release-notes/deprecated-and-removed-features.mdsite/content/arangodb/4.0/release-notes/version-3.12/incompatible-changes-in-3-12.md
✅ Files skipped from review due to trivial changes (9)
- site/content/arangodb/4.0/operations/backup-and-restore.md
- site/content/arangodb/3.12/operations/backup-and-restore.md
- site/content/arangodb/4.0/features/list.md
- site/content/arangodb/4.0/release-notes/version-3.12/incompatible-changes-in-3-12.md
- site/content/arangodb/3.11/features/highlights-by-version.md
- site/content/arangodb/3.12/release-notes/version-3.12/incompatible-changes-in-3-12.md
- site/content/arangodb/4.0/release-notes/deprecated-and-removed-features.md
- site/content/arangodb/3.11/operations/backup-and-restore.md
- site/content/arangodb/3.12/release-notes/deprecated-and-removed-features.md
🚧 Files skipped from review as they are similar to previous changes (1)
- site/content/arangodb/3.11/features/list.md
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
1 participant
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
Upstream PRs
Summary by CodeRabbit
Documentation
arangobackup/rclone examples (removed ACL from S3 samples; renamedcopy-linkstocopy_links).PERCENTILE()documentation (including behavior and signature).Updates