Skip to content

Commit

Permalink
docs: correct list ordering
Browse files Browse the repository at this point in the history
  • Loading branch information
mariajgrimaldi committed Oct 29, 2024
1 parent 1ff6b1a commit e65ce9d
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions docs/decisions/0017-generalized-containers.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,10 +22,10 @@ Decisions
- A container marks any PublishableEntity, such as sections, subsections, units, or any other custom content type, as a type that can hold other content.
- Containers might be of different types, with each type potentially having different restrictions on the type of content it can hold but that will not be enforced by containers.
- Content restrictions for containers are implemented at the app layer, allowing specific container types, like Unit, to limit their members to particular content types (e.g., only Components).
- The course hierarchy Course > Section > Subsection > Unit will be implemented as relationships between containers, with each level acting as a container that holds other content. The hierarchy will be enforced by the content restrictions of each particular container but allowed to be overridden to support `0002-content-extensibility.rst`.
- Containers will follow extensibility principles in `0003-content-extensibility.rst` for creating new container types or subtypes, static or dynamic.
- The course hierarchy Course > Section > Subsection > Unit will be implemented as relationships between containers, with each level acting as a container that holds other content. The hierarchy will be enforced by the content restrictions of each particular container but allowed to be overridden to support `0002-content-flexibility.rst`_.
- Containers will follow extensibility principles in `0003-content-extensibility.rst`_ for creating new container types or subtypes, static or dynamic.

1. Container Members and Relationships
3. Container Members and Relationships
=======================================

- The members of a container can be any type of publishable content.
Expand All @@ -36,17 +36,17 @@ Decisions
- Each child can be fixed to a particular version or set to point to the latest version for draft and published states. Draft or published states can be referenced without creating new instances for each version update by using the convention of setting the reference to `None`.
- If the child's draft or published version is pinned, then each time versions are updated, a new child with the new reference must be created.

1. Container Versioning Management
4. Container Versioning Management
==================================

- The container itself is versioned, and a new version is created if and only if the container itself changes (e.g., title, ordering of contents, adding or removing content) and not when its content changes (e.g., a component in a Unit is updated with new text).

1. Publishing
5. Publishing
=============

WIP

1. Pruning
6. Pruning
==========

WIP
Expand Down

0 comments on commit e65ce9d

Please sign in to comment.