Skip to content

Commit

Permalink
build: Minor adjustments to release notes (microsoft#23464)
Browse files Browse the repository at this point in the history
Minor update to release notes to add a shorter title for one change.
  • Loading branch information
tylerbutler authored Jan 6, 2025
1 parent 102b9b8 commit abad97f
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 2 deletions.
2 changes: 2 additions & 0 deletions .changeset/moody-pandas-fall.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@
"section": tree
---

New alpha APIs for schema evolution

There are now `@alpha` APIs for schema evolution which support adding optional fields to object node types without a staged rollout.

SharedTree has many safety checks in place to ensure applications understand the format of documents they must support.
Expand Down
6 changes: 4 additions & 2 deletions RELEASE_NOTES/2.13.0.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,14 @@
## Contents

- [🌳 SharedTree DDS Changes](#-sharedtree-dds-changes)
- [There are now `@alpha` APIs for schema evolution which support adding optional fields to object node types without a staged rollout. (#23362)](#there-are-now-alpha-apis-for-schema-evolution-which-support-adding-optional-fields-to-object-node-types-without-a-staged-rollout-23362)
- [New alpha APIs for schema evolution (#23362)](#new-alpha-apis-for-schema-evolution-23362)
- [Metadata can be associated with Node Schema (#23321)](#metadata-can-be-associated-with-node-schema-23321)

## 🌳 SharedTree DDS Changes

### There are now `@alpha` APIs for schema evolution which support adding optional fields to object node types without a staged rollout. ([#23362](https://github.com/microsoft/FluidFramework/issues/23362))
### New alpha APIs for schema evolution ([#23362](https://github.com/microsoft/FluidFramework/issues/23362))

There are now `@alpha` APIs for schema evolution which support adding optional fields to object node types without a staged rollout.

SharedTree has many safety checks in place to ensure applications understand the format of documents they must support. One of these checks verifies that the view schema (defined in application's code) aligns with the document schema (determined by the document data at rest). This helps to ensure that clients running incompatible versions of the application's code don't collaborate at the same time on some document, which could cause data loss or disrupt application invariants. One general solution application authors can perform is to stage the rollout of a feature which changes document schema into multiple phases:

Expand Down

0 comments on commit abad97f

Please sign in to comment.