Skip to content

Commit

Permalink
docs: add key concepts to reduce ambiguity
Browse files Browse the repository at this point in the history
  • Loading branch information
mariajgrimaldi committed Mar 5, 2025
1 parent bb7c526 commit 20688f1
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions docs/decisions/0017-generalized-containers.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,19 @@ Context

This ADR proposes a model for containers that can hold different types of content and can be used to model other content types with similar behavior, such as units, subsections, sections, or courses. The model defines containers' core structure and purpose, the types of containers, content constraints, container children, version control, publishing, and pruning.

Key Concepts
============

The following definitions provide context for the terms used in this ADR:

- Container: A content structure that holds other content types in a parent-child hierarchy (e.g., sections, subsections, units).
- PublishableEntity: A versioned content type that supports publishing and can exist independently or within a container (e.g., sections, units, components).
- Versioning: The process of creating new container versions when its structure or metadata changes (e.g., title, order, adding/removing children).
- Soft-deletion: Removing a draft or published entity by setting its version to NULL, while keeping historical versions for potential reverts.
- Publishing: Making a container and its content available in a published state.
- Pruning: Removing unused, unpublished container versions if they are not the latest and have no references.
- Selectors: A mechanism for dynamically selecting multiple PublishableEntities based on defined criteria (e.g., split testing, randomized content selection).

Decisions
---------

Expand Down

0 comments on commit 20688f1

Please sign in to comment.