Skip to content

docs: clarify graph maintenance and client routing - #519

Draft
imbajin wants to merge 11 commits into
apache:masterfrom
hugegraph:fix/doc-graph-reload
Draft

imbajin wants to merge 11 commits into
apache:masterfrom
hugegraph:fix/doc-graph-reload

Conversation

@imbajin

@imbajin imbajin commented Oct 12, 2026 •

Copy link
Copy Markdown
Member

Graph maintenance documentation described guarantees beyond the current Server behavior. Align the Chinese and English API, configuration, FAQ and quickstart pages with the local task-drain and graph-deletion scope of apache/hugegraph#3308.

Stop writes and tasks on every participating Server before maintenance. Confirm deletion and cleanup on each Server before recreating the same name; notifications do not form a cluster barrier. Use restart for configuration changes, and inspect uncertain cleanup. Reload retains its existing backend-clear risk without PD; the pages do not promise global recovery or replacement ownership.

Keep the existing Go GraphSpace schema-routing correction and API parameters. Complete private-space CRUD and multi-Server acceptance remain open.

Validation: existing source tests, links, strict Hugo builds, versioned artifacts, search checks and bilingual rendered-page readback passed; one independent final documentation review found no outstanding issue. Both PRs remain drafts while current-head CI and the matching Server integration are tracked.

Org validation: hugegraph#45

- describe startup source recovery and failure retries
- document local deletion protection across graph spaces
- explain authentication and cache RPC reload limits
- align configuration references with startup sources
- preserve reload protection and recovery boundaries
- wrap the added prose to the repository line limit
- document overlapping reload rejection and retry
- qualify closed graph cleanup and data boundaries
- explain local task owner waits and forced cancellation
- merge current documentation master
- align schema graph space routes with the Go client
- preserve merged edge label and error guidance
@imbajin imbajin changed the title docs: explain graph reload recovery docs: clarify graph lifecycle and client routing Oct 12, 2026
- describe the manager lifecycle admission guard
- retain explicit retry and notification boundaries
- align the Chinese and English API guidance
- explain deferred remote graph removal notifications
- include overlapping operations in reload error summary
- distinguish local waiting from distributed task deletion
- require quiesced writes during deletion and retries
- retain failed owners only for cleanup recovery
- explain partial deletion and closed task admission
- describe local publication and notification coordination
- retain quota and local configuration protection rules
- prohibit same-name recreation during failed cleanup
- document explicit recovery after replacement failures
- describe waiting behind an active lifecycle operation
- state the wait has no configured timeout
- distinguish interruption and immediate API rejection
- make file removal mandatory for reload and restart
- explain retained files restore deletion protection
- preserve the DEFAULT graph-space protection scope
@imbajin
imbajin marked this pull request as draft October 12, 2026 17:04
- describe local task drain and manual maintenance
- require restart for configuration changes
- clarify uncertain cleanup and reload data risk
- preserve existing Go schema routing guidance
@imbajin imbajin changed the title docs: clarify graph lifecycle and client routing docs: clarify graph maintenance and client routing Oct 12, 2026

This branch has not been deployed

No deployments
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.

1 participant