Conversation
Contributor
|
🤖: Deployment available as https://docstest.simplyblock.io/fd-labels |
"Data center" and "datacenter" are both correct English, which is why the documentation carried six of the first and none of the second. Only one of them can be the house spelling, and the one-word form is picked. check-prose.py gains a one-word-compound rule for the class of compounds that have two accepted spellings. It matches the spaced and the hyphenated form together with a trailing plural "s", keeps a leading capital through the rewrite so a heading and the start of a sentence survive it, and reports the finding as the house decision it is rather than as a misspelling. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
`sn add-node --failure-domain` takes a label (`RACK1`, `AZ2`, `HOST1`) rather than a non-negative integer. The integer stays the internal identity that placement, the distrib cluster map and the expansion planner key off, and the v2 API keeps its integer `failure_domain` field, but it no longer has to be invented or tracked by hand. Two sections are new on the operations page. "Label Syntax" gives the grammar: a letter followed by up to 31 of `[A-Z0-9_-]`, case-insensitive and stored upper-cased. "Labels on Existing Clusters" covers initialization through `cluster update`, which names every id in service `FD<id>` or `HOST<id>`. It is idempotent, so a later rename survives, and it refuses to take a derived name already owned by a different id. An all-digits value is still read as the internal id, so existing scripts, CI bootstraps and the Kubernetes operator keep working unchanged. The node list's Failure Domain column shows the label and falls back to the id for a cluster that has not been initialized. `reference/operator/reference.md` is generated CRD documentation and is untouched: the Kubernetes `failureDomain` field lives in the operator repository and needs its own change to accept labels. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Contributor
|
🤖: Deployment available as https://docstest.simplyblock.io/fd-labels |
"However the volume stays online" reads as a sentence about however many
volumes until the verb arrives and the reader has to start over. The
comma is what marks the word as a comment on the sentence rather than as
part of it, and the documentation already wrote it that way in 37 of 37
"However" and 17 of 17 "Therefore". The eight places that did not are
corrected here.
check-prose.py gains an introductory-comma rule over two lists. A
connective ("However", "Therefore", "Otherwise", "By default") can only
join clauses and is reported whatever follows it. A sentence adverb
("Internally", "Typically", "Today", "Now") can also modify the word
behind it, so it is reported only where no participle or adjective
follows and "Initially developed by Google" stays as it is.
Guarded against three shapes that must not take the comma: the phrase
continued into a preposition or a conjunction ("Instead of", "Now that",
"Together with", "In addition to", "However many"), the adverb modifying
the word behind it, and the bold subject of a list item. "Then" and
"First" are left out entirely, since they number the steps of a
procedure and take no comma there.
Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
The skill is what a writer reads before a page, so a rule the gate enforces has to be findable there and not only in the checker. Adds the introductory comma with the three shapes that are exempt from it, and the one-word compound with "datacenter" as its first entry. The punctuation section no longer counts itself as three habits. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Contributor
|
🤖: Deployment available as https://docstest.simplyblock.io/fd-labels |
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
2 participants
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.
Documents the failure-domain / physical labels feature built on
simplyblock/sbclibranchfeature/fd-labels(commitd9732101).What changes for the operator
sn add-node --failure-domaintakes a label —RACK1,AZ2,HOST1— instead of a non-negative integer. The integer is still the internal identity (placement, the distrib cluster map and the expansion planner all key off it, and the v2 API keeps its integerfailure_domainfield, now alongsidefailure_domain_label), but operators no longer invent or track it.Pages touched
architecture/concepts/failure-domains.md— domains are named rather than numbered; the label→id mapping is described as an internal detail.non-kubernetes/operations/failure-domains.md— examples switched toRACK1/RACK2; two new sections:[A-Z0-9_-], case-insensitive, stored upper-cased.cluster update, which names each id in serviceFD<id>/HOST<id>. Idempotent, so a later rename survives; refuses to take a derived name already owned by a different id.Compatibility, documented explicitly
An all-digits
--failure-domainvalue is still read as the internal id, so existing scripts, CI bootstraps and the Kubernetes operator keep working unchanged. The node list's Failure Domain column shows the label and falls back to the id for a cluster that has not been initialized.Notes for review
main: this repo has nodevbranch (default ismain, with releases cut torelease/*/R25.*). Happy to retarget.reference/operator/reference.mdis generated CRD documentation and is untouched — the KubernetesfailureDomainfield lives in the operator repo and would need its own change to accept labels.🤖 Generated with Claude Code