Skip to content

Docs/endpoint to network#534

Merged
arseny-dragonflydb merged 3 commits into
mainfrom
docs/endpoint-to-connectivity
Jun 9, 2026
Merged

Docs/endpoint to network#534
arseny-dragonflydb merged 3 commits into
mainfrom
docs/endpoint-to-connectivity

Conversation

@arseny-dragonflydb

Copy link
Copy Markdown
Contributor
  • Updates docs to match UI change

@vercel

vercel Bot commented Jun 7, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
documentation Ready Ready Preview, Comment Jun 9, 2026 6:48am

Request Review

@qodo-free-for-open-source-projects

qodo-free-for-open-source-projects Bot commented Jun 7, 2026

Copy link
Copy Markdown

Code Review by Qodo

🐞 Bugs (2) 📘 Rule violations (0) 📎 Requirement gaps (0) 🎨 UX issues (0)

Grey Divider


Remediation recommended

1. TLS defaults contradicted 🐞 Bug ≡ Correctness
Description
In docs/cloud/connect/redis-clients.md the notes say the examples use public connectivity with TLS
disabled, but docs/cloud/datastores.md states public connectivity is default with TLS enabled,
leaving contradictory connection guidance for the same feature.
Code

docs/cloud/connect/redis-clients.md[24]

+  to replace those placeholders in the code snippets below, where we use public connectivity with the `default` user and TLS disabled.
Evidence
The Redis clients page explicitly says TLS is disabled in the examples, while the Data Stores
security section states TLS is enabled by default for public connectivity; both statements cannot be
simultaneously true as general guidance.

docs/cloud/connect/redis-clients.md[21-25]
docs/cloud/datastores.md[113-122]

Agent prompt
The issue below was found during a code review. Follow the provided context and guidance below and implement a solution

## Issue description
`docs/cloud/connect/redis-clients.md` states that the snippets use public connectivity with TLS disabled, while `docs/cloud/datastores.md` states public connectivity defaults to TLS enabled. This contradiction can confuse users about whether they must configure TLS for public connectivity.
### Issue Context
This PR touched the `redis-clients.md` note line while updating terminology; it’s a good place to reconcile the pre-existing TLS guidance mismatch.
### Fix Focus Areas
- docs/cloud/connect/redis-clients.md[21-26]
- docs/cloud/datastores.md[113-132]
### Suggested direction
Update the Redis clients note to either:
- remove/avoid claiming “TLS disabled” and instead tell readers to use the provided Connection URI (which should encode TLS requirements), or
- explicitly say the snippets show *non-default* non-TLS examples and add a short TLS-enabled variant (or instructions) consistent with the public connectivity defaults.

ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools


2. VPN snippet uses endpoint 🐞 Bug ⚙ Maintainability
Description
docs/cloud/connect/vpn/gcp.md was updated to say “private connectivity address”, but the code sample
still uses the placeholder hostname your-private-endpoint.internal, leaving mixed terminology on
the same page.
Code

docs/cloud/connect/vpn/gcp.md[68]

+1. Use your standard Dragonfly client with the private connectivity address
Evidence
The same section first tells users to use a “private connectivity address” and then shows a code
snippet using a “private-endpoint” placeholder hostname, demonstrating the inconsistency directly.

docs/cloud/connect/vpn/gcp.md[64-84]

Agent prompt
The issue below was found during a code review. Follow the provided context and guidance below and implement a solution

## Issue description
The GCP VPN guide now instructs users to use a “private connectivity address”, but the example code still uses `your-private-endpoint.internal`. This inconsistency can confuse readers about which value to substitute.
### Issue Context
Only the prose line was updated in this PR; the snippet immediately below still carries the old placeholder terminology.
### Fix Focus Areas
- docs/cloud/connect/vpn/gcp.md[64-84]
### Suggested direction
Rename the placeholder and/or comment to match the new wording (e.g., `host='your-private-connectivity.internal'` or a generic `your-private-connectivity-address.internal`) so the instruction and example align.

ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools


Grey Divider

Qodo Logo

@qodo-free-for-open-source-projects

Copy link
Copy Markdown

Review Summary by Qodo

Update documentation terminology from endpoint to connectivity

📝 Documentation

Grey Divider

Walkthroughs

Description
• Replace "endpoint" terminology with "connectivity" across documentation
• Update UI references from "Endpoint" dropdown to "Connectivity" dropdown
• Clarify ACL rules access location in datastores documentation
• Standardize terminology for public and private access methods
Diagram
flowchart LR
  A["Old Terminology:<br/>public/private endpoint"] -->|Replace| B["New Terminology:<br/>public/private connectivity"]
  C["UI Reference:<br/>Endpoint dropdown"] -->|Update to| D["UI Reference:<br/>Connectivity dropdown"]
  E["ACL Rules Location:<br/>three-dot menu"] -->|Clarify to| F["Access menu<br/>then ACL Rules"]

Loading

Grey Divider

File Changes

1. docs/cloud/connect/redis-clients.md 📝 Documentation +1/-1

Update endpoint to connectivity terminology

• Changed "public endpoints" to "public connectivity" in connection notes

docs/cloud/connect/redis-clients.md


2. docs/cloud/connect/vpn/aws.md 📝 Documentation +2/-2

Standardize private endpoint to connectivity

• Replaced "private endpoint datastore" with "private connectivity datastore" in two locations
• Updated terminology for consistency across VPN connection guide

docs/cloud/connect/vpn/aws.md


3. docs/cloud/connect/vpn/gcp.md 📝 Documentation +2/-2

Replace endpoint with connectivity terminology

• Changed "private endpoint" to "private connectivity" in prerequisites
• Updated client connection instructions to use new terminology

docs/cloud/connect/vpn/gcp.md


View more (6)
4. docs/cloud/connect/vpn/vpn.md 📝 Documentation +1/-1

Update VPN guide terminology

• Updated main guide description to use "private connectivity" instead of "private endpoint"

docs/cloud/connect/vpn/vpn.md


5. docs/cloud/connections.md 📝 Documentation +4/-4

Standardize connectivity terminology

• Replaced "private endpoint" with "private connectivity" in two sections
• Updated documentation references for AWS and Azure peering connections

docs/cloud/connections.md


6. docs/cloud/datastores.md 📝 Documentation +15/-15

Comprehensive endpoint to connectivity terminology update

• Replaced all instances of "endpoint" with "connectivity" throughout security section
• Updated section headers from "Public Endpoint" to "Public Connectivity" and "Private Endpoint" to
 "Private Connectivity"
• Changed UI reference from "Endpoint dropdown" to "Connectivity dropdown"
• Updated Memcached documentation to reference private connectivity

docs/cloud/datastores.md


7. docs/cloud/networks.md 📝 Documentation +2/-2

Update private network connectivity terminology

• Changed "private endpoint" to "private connectivity" in network creation documentation
• Updated description of private network benefits

docs/cloud/networks.md


8. docs/cloud/pricing.md 📝 Documentation +1/-1

Update pricing documentation terminology

• Updated pricing reference from "data stores with private endpoints" to "data stores with private
 connectivity"

docs/cloud/pricing.md


9. docs/cloud/datastores.md 📝 Documentation +15/-15

Clarify ACL rules menu navigation

• Clarified ACL rules access path from "three-dot menu and click ACL Rules" to "three-dot menu then
 select Access -> ACL Rules"

docs/cloud/datastores.md


Grey Divider

Qodo Logo

@arseny-dragonflydb arseny-dragonflydb changed the title Docs/endpoint to connectivity Docs/endpoint to network Jun 9, 2026
@arseny-dragonflydb arseny-dragonflydb merged commit 85eada1 into main Jun 9, 2026
3 checks passed
@arseny-dragonflydb arseny-dragonflydb deleted the docs/endpoint-to-connectivity branch June 9, 2026 11:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants