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

Begin recording architecture decisions #341

Merged
merged 2 commits into from
Oct 16, 2023

Conversation

ahouseholder
Copy link
Contributor

This PR adds the /docs/adr directory and creates two starter architecture decisions

  • 0000 to record architecture decisions
  • 0001 to use MADR format for them

References:

Rationale:

  • We need a place to capture the outcomes of decisions within the project.
  • ADR (and the MADR format in particular) seem to be a good enough place to start.

I can see this being where we capture things like

  • why some things get versioned and others do not
  • why SSVC decision points are ordered sets
  • why SSVC outcome sets are ordered sets
  • why we treat trees as examples not strict rules
  • and even some of the things that went into the original paper (like the decision trees vs other alternatives)

also exclude them from generated site
@ahouseholder ahouseholder requested a review from j--- October 16, 2023 14:34
@ahouseholder ahouseholder self-assigned this Oct 16, 2023
@ahouseholder ahouseholder added documentation Improvements or additions to documentation enhancement New feature or request environment Project environment, deployment, CI, etc. labels Oct 16, 2023
@ahouseholder ahouseholder added this to the SSVC 2023Q4 milestone Oct 16, 2023
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.

This is a good idea, thank you.

@ahouseholder ahouseholder merged commit 798ff57 into CERTCC:main Oct 16, 2023
1 check passed
@ahouseholder ahouseholder deleted the feature/add_adr branch October 16, 2023 19:20
jeroenh pushed a commit to jeroenh/SSVC that referenced this pull request Oct 18, 2023
also exclude them from generated site
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 environment Project environment, deployment, CI, etc.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants