Repository navigation
Move acceptance API docs to docs/ and fix hot failover rollback guidance - #25
Draft
fredzhang-aveva wants to merge 1 commit into
Draft
fredzhang-aveva wants to merge 1 commit into
fredzhang-aveva wants to merge 1 commit into
Conversation
Move the awaitable scope (acceptance API) docs from Documentation/ to docs/acceptance-api/ so all framework docs live under docs/, and link them from the README. Correct the hot failover section of docs/schema-partition-keys.md to match the V6 failover buffer format. Every hot-failover record is written as V6, and earlier releases skip V6 records as corrupt instead of misreading them, so the buffer must be drained before rolling back. Replace the ScopedWrites.md link to the removed HotFailoverAcceptance.md with the README Additional documentation section, and refer to the product as the Adapter Framework in the sidecar slicing walkthrough.
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
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.
Move acceptance API docs to docs/ and fix hot failover rollback guidance
Work item:
Intent
Documentation-only change in preparation for release notes.
Documentation/todocs/acceptance-api/, so all framework docs live underdocs/. LinkScopedWrites.mdfrom the README "Additional documentation" list so the acceptance API docs are discoverable.docs/schema-partition-keys.md. It described V3 failover records and an older reader misreading them, butFailoverPersistentOmfMessageQueuealways writes V6 records, and earlier releases (verified againstv2.1.0) don't recognize V6 and skip them as corrupt. The rollback warning now says the buffer must be drained before rolling back, and cross-references the V5 endpoint-buffer limitation in the README.ScopedWrites.mdlink toHotFailoverAcceptance.md, which was removed before the acceptance API merged, with a link to the README "Additional documentation" section.SidecarSlicingWalkthrough.md.Alternatives considered
Documentation/. Rejected because the repo would keep two top-level doc folders with no clear split.HotFailoverAcceptance.md. Rejected because the README already covers hot failover behavior for scopes, and a separate page would duplicate it.Breaking changes
None to code or packages. External links to
Documentation/*.mdon GitHub will break because the files moved todocs/acceptance-api/.Not included
The README "Releases" section still lists 2.1.0. Main's build version is 2.1.1, but the release date and release notes URL aren't available yet.
Validation
docs/resolve.dotnet test Src/AdapterFramework.slnpasses, 3,262 tests, 0 failures.dotnet format Src/AdapterFramework.sln --verify-no-changesanddotnet build -warnaserrorfail onmainwith existing findings in untouched.csfiles, such as CHARSET, IMPORTS, CA1848, and CA1852. This PR doesn't change those results.Pipeline runs