docs: explicitly state that _sharing is not inherited and defaults to private - #13
Open
mitselek wants to merge 1 commit into
Open
docs: explicitly state that _sharing is not inherited and defaults to private#13mitselek wants to merge 1 commit into
mitselek wants to merge 1 commit into
Conversation
… private The existing docs describe _sharing defaults and _inheritrights propagation in separate sections, but neither explicitly states the combined behaviour: _sharing is not propagated via _inheritrights, and an entity with no explicit _sharing defaults to private regardless of its parent. This has caused two independent integrator teams to assume _sharing inherits like the four rights properties do. One-line info block in the Sharing section, between the existing danger block and the Rights Inheritance heading. Closes #12 Co-authored-by: Mihkel Putrinš <mihkel.putrinsh@gmail.com>
This was referenced Jun 6, 2026
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
1 participant
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.
One-line clarification in the Sharing section of
src/overview/entities/index.md.The existing docs describe
_sharingdefaults ("private is the default") and_inheritrightspropagation ("only_viewer,_expander,_editor, and_ownerare inherited") in separate sections, but neither explicitly states the combined behaviour:_sharingis not propagated via_inheritrights, and an entity with no explicit_sharingdefaults toprivateregardless of its parent's setting.We've now seen two independent integrator teams assume
_sharinginherits from the parent (like the four rights do), and design bulk operations around that wrong model. A single explicit sentence prevents this.Closes #12