Skip to content

Commit

Permalink
Differentiation between standards and decision records (#352)
Browse files Browse the repository at this point in the history
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
cah-hbaum committed Mar 11, 2024
1 parent 3a3c524 commit 8d20932
Show file tree
Hide file tree
Showing 2 changed files with 52 additions and 4 deletions.
41 changes: 41 additions & 0 deletions Standards/scs-XXXX-vN-decision-record-template.md
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
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
---
title: _Descriptive title_
type: Standard # | Decision Record | Procedural
type: Standard # | Procedural
status: Draft
track: Global # | IaaS | Ops | KaaS | IAM
author: Author <Mail or Github handle>
date: DD-MM-YYYY
---

<!---
Expand All @@ -16,6 +18,11 @@ See https://github.com/SovereignCloudStack/standards/blob/main/Standards/scs-000

Introduction

## Terminology

Example (abbr. Ex)
This is the description for an example terminology.

## Motivation

Motivation
Expand All @@ -34,13 +41,13 @@ Option 1 description

Option 2 description

## Open questions
### Open questions

RECOMMENDED

## Decision
## Standard

Decision
Standard

## Related Documents

Expand Down

0 comments on commit 8d20932

Please sign in to comment.