Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add building block analogy explainer #447

Merged
merged 8 commits into from
Feb 15, 2024

Conversation

ahouseholder
Copy link
Contributor

@ahouseholder ahouseholder commented Feb 9, 2024

This PR

  • adds docs/topics/decision_points_as_bricks.md that explains the LEGO® bricks analogy we've been talking about for a while.
  • resolves Reframe Decision Points as first-order objects in SSVC #296 (see additional comment below this list)
  • makes an unrelated incidental update to docs/topics/enumerating_decisions.md to clean up a few nits

When combined with the update to topics/index.md that appeared in #424, I believe this PR adequately addresses #296.

Note: I checked the LEGO® trademark page to confirm that it's okay to mention the name as long as it's an adjective, not a noun, and include the disclaimer that appears in the offset box in the accompanying text:

LEGO® is a trademark of the LEGO Group of companies which does not sponsor, authorize or endorse this site.

I was also careful to limit the mentions of the trademark to the top of the doc, so if for some reason we needed to remove it we could do so with minimal effect on the rest of the page.

@ahouseholder ahouseholder added documentation Improvements or additions to documentation enhancement New feature or request labels Feb 9, 2024
@ahouseholder ahouseholder added this to the SSVC 202403 milestone Feb 9, 2024
@ahouseholder ahouseholder self-assigned this Feb 9, 2024
Copy link
Collaborator

@j--- j--- left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Really good! Just two questions.

docs/topics/decision_points_as_bricks.md Outdated Show resolved Hide resolved
docs/topics/decision_points_as_bricks.md Outdated Show resolved Hide resolved
@ahouseholder ahouseholder requested a review from j--- February 14, 2024 18:53
Copy link
Collaborator

@j--- j--- left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! LGTM.

@ahouseholder ahouseholder merged commit ad427b3 into main Feb 15, 2024
4 checks passed
@ahouseholder ahouseholder deleted the 296-decision-points-as-primary-focus branch February 15, 2024 18:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Reframe Decision Points as first-order objects in SSVC
2 participants