Skip to content

docs: correct deprecated ChunkSize and document backup chunking variables#473

Open
g-despot wants to merge 1 commit into
mainfrom
docs/backup-chunking-and-google-location
Open

docs: correct deprecated ChunkSize and document backup chunking variables#473
g-despot wants to merge 1 commit into
mainfrom
docs/backup-chunking-and-google-location

Conversation

@g-despot

Copy link
Copy Markdown
Contributor

Fixes documentation that is wrong or missing for users on current releases. No 1.39 content.

  • ChunkSize was documented as a working backup option with a default, minimum and maximum. It has had no effect since it was removed in core (present as deprecated in v1.38.5 and every supported line). Now marked deprecated, pointing at BACKUP_CHUNK_TARGET_SIZE.
  • BACKUP_MIN_CHUNK_SIZE, BACKUP_CHUNK_TARGET_SIZE and BACKUP_SPLIT_FILE_SIZE were undocumented. Added, with a note on how their values are raised against each other.
  • text2vec-google gained a location parameter that was never documented. Optional, defaults to us-central1.

No version markers anywhere: each of these landed across several stable lines, so no single version is correct for every supported release.

Site build passes.

…bles

ChunkSize has had no effect since its removal in core, but the page
documented it as a working option with a default, minimum and maximum.
Mark it deprecated and point to BACKUP_CHUNK_TARGET_SIZE.

Document BACKUP_MIN_CHUNK_SIZE, BACKUP_CHUNK_TARGET_SIZE and
BACKUP_SPLIT_FILE_SIZE, which were undocumented, including how their
values are raised against each other.

Document the location parameter for text2vec-google.

No version markers: these all landed across several stable lines, so no
single version is correct for every supported release.

@orca-security-eu orca-security-eu Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Orca Security Scan Summary

Status Check Issues by priority
Passed Passed Infrastructure as Code high 0   medium 0   low 0   info 0 View in Orca
Passed Passed SAST high 0   medium 0   low 0   info 0 View in Orca
Passed Passed Secrets high 0   medium 0   low 0   info 0 View in Orca
Passed Passed Vulnerabilities high 0   medium 0   low 0   info 0 View in Orca

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