-
Notifications
You must be signed in to change notification settings - Fork 24
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Differentiation between standards and decision records (#352)
Adds a template for decision records and updates the template for standards, since both document types are different from each other. Signed-off-by: Hannes Baum <[email protected]>
- Loading branch information
Showing
2 changed files
with
52 additions
and
4 deletions.
There are no files selected for viewing
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,41 @@ | ||
--- | ||
title: _Descriptive title_ | ||
type: Decision Record | ||
status: Draft | ||
track: Global # | IaaS | Ops | KaaS | IAM | ||
author: Author <Mail or Github handle> | ||
date: DD-MM-YYYY | ||
--- | ||
|
||
<!--- | ||
This is a template striving to provide a starting point for | ||
creating a standard or decision record adhering to scs-0001. | ||
Replace at least all text which is _italic_. | ||
See https://github.com/SovereignCloudStack/standards/blob/main/Standards/scs-0001-v1-sovereign-cloud-standards.md | ||
---> | ||
|
||
## Introduction | ||
|
||
Introduction | ||
|
||
## Terminology | ||
|
||
Example (abbr. Ex) | ||
This is the description for an example terminology. | ||
|
||
## Context | ||
|
||
What is the issue that we're seeing that is motivating this decision or change? | ||
|
||
## Decision | ||
|
||
What is the decision that we're proposing and/or doing? | ||
Should also include reasoning for this decision | ||
|
||
## Consequences | ||
|
||
What becomes easier or more difficult to do because of this change? | ||
|
||
## Related Documents | ||
|
||
Related Documents, OPTIONAL |
This file contains 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