Repository navigation
docs: state 0.7.5 stable and 0.7.6 preview, rewrite the specification against 0.7.5, and make every example validate - #51
Merged
Conversation
… against 0.7.5, and make every example validate The version and status model (0.7.5 latest stable, 0.7.6 preview); new 0.7.6 preview notes derived from the schema, with the authoritative bucket-policy warning; the 0.7.5 release note and changelog corrected; specification.md rewritten against 0.7.5, with an accurate, non-normative description of multi-file composition in place of the .fluid/ recommendation; anatomy, cheatsheet and minimal-contract examples that validate, and the complete Lake Formation admins warning; licence mentions that match LICENSE. Signed-off-by: Speculator55005 <50082482+fas89@users.noreply.github.com>
fas89
force-pushed
the
docs/spec-truth-076
branch
from
October 5, 2026 09:26
3fa2451 to
65a0ebb
Compare
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.
What this changes
A truth pass over the spec site's documentation, measured against the schemas #50 publishes (0.7.5 stable, 0.7.6 preview) and against how the reference implementation (data-product-forge 0.18.1) behaves.
README.md,docs/schema/versions.mdanddocs/releases/README.mdsay 0.7.5 is the latest stable version and 0.7.6 is a preview: what "preview" means, how a contract opts in, and that a preview can change until it is promoted.versions.mdrecords that the published 0.7.1 and the reference implementation's 0.7.1 differ under the same$id.docs/releases/0.7.6.md(preview), derived from the 0.7.6 schema itself.packaging,consumers,consumes[].upstreamWorkspace/upstreamDigest(tied bydependentRequired),measures[].aggParams,binding.encryption.kms,exposes[].lifecycle.expire,binding.principalsandlakeFormation.bucketPolicy.vectorConfig, Iceberg catalog location, Redshift Serverless / Kinesis). Its headline example did not validate and now does.specification.md..fluid/directory, which is the reference implementation's runtime state directory. It now gives an accurate, explicitly non-normative description:fragments/layout;fluid split/fluid bundle.adminscarries the authoritative warning: unlisted admins are removed, and destroying the resource empties the list.docs/concepts/forge-cli.md: the package isdata-product-forge, and the page states version support and the composition commands.LICENSE(Apache 2.0).The spec stays neutral: forge-cli is described as the reference implementation, and nothing here changes which documents validate.
Tested
npm run docs:buildsucceeds.conformance.ymlfinds no internal absolute link without/fluid/.fluid validate(0.18.1), against the schema version it declares./fluid/and opened it in a browser.fragments/layout and links the forge docs.Security review
The review covered both PRs; findings that belong to docs are fixed here. They are the bucket-policy danger box, the completed
adminswarnings and accurate drift-check wording.Commits are DCO signed-off.