Skip to content

Commit a4c82e2

Browse files
committed
Add frontmatter w/ sidebar config to ADRs
This is to refelct the same dir structure as toplevel. For example the blog iagaes are below blog/, so docs images shouldbe below docs/. Use of the new sidebar auto generation feature. Signed-off-by: Sven Strittmatter <sven.strittmatter@iteratec.com>
1 parent af240ef commit a4c82e2

11 files changed

Lines changed: 90 additions & 68 deletions

File tree

docs/adr/adr_0001.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
1-
<!--
2-
SPDX-FileCopyrightText: the secureCodeBox authors
3-
4-
SPDX-License-Identifier: Apache-2.0
5-
-->
6-
1+
---
2+
# SPDX-FileCopyrightText: the secureCodeBox authors
3+
#
4+
# SPDX-License-Identifier: Apache-2.0
5+
6+
title: "ADR-0001: Choosing the framework for the new secureCodeBox Website"
7+
sidebar_label: "ADR-0001"
8+
---
79
# ADR-0001: Choosing the framework for the new secureCodeBox Website
810

911
| <!-- --> | <!-- --> |

docs/adr/adr_0002.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
1-
<!--
2-
SPDX-FileCopyrightText: the secureCodeBox authors
3-
4-
SPDX-License-Identifier: Apache-2.0
5-
-->
6-
1+
---
2+
# SPDX-FileCopyrightText: the secureCodeBox authors
3+
#
4+
# SPDX-License-Identifier: Apache-2.0
5+
6+
title: "ADR-0002: How can we introduce a more general extension concept for data processing modules?"
7+
sidebar_label: "ADR-0002"
8+
---
79
# ADR-0002: How can we introduce a more general extension concept for data processing modules?
810

911
| <!-- --> | <!-- --> |

docs/adr/adr_0003.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
1-
<!--
2-
SPDX-FileCopyrightText: the secureCodeBox authors
3-
4-
SPDX-License-Identifier: Apache-2.0
5-
-->
6-
1+
---
2+
# SPDX-FileCopyrightText: the secureCodeBox authors
3+
#
4+
# SPDX-License-Identifier: Apache-2.0
5+
6+
title: "ADR-0003: How can we introduce a mechanism to start specialized scans on the results of previous scans?"
7+
sidebar_label: "ADR-0003"
8+
---
79
# ADR-0003: How can we introduce a mechanism to start specialized scans on the results of previous scans?
810

911
| <!-- --> | <!-- --> |

docs/adr/adr_0004.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
1-
<!--
2-
SPDX-FileCopyrightText: the secureCodeBox authors
3-
4-
SPDX-License-Identifier: Apache-2.0
5-
-->
6-
1+
---
2+
# SPDX-FileCopyrightText: the secureCodeBox authors
3+
#
4+
# SPDX-License-Identifier: Apache-2.0
5+
6+
title: "ADR-0004: Which framework could be more useful for documentation purposes?"
7+
sidebar_label: "ADR-0004"
8+
---
79
# ADR-0004: Which framework could be more useful for documentation purposes?
810

911
| <!-- --> | <!-- --> |

docs/adr/adr_0005.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
1-
<!--
2-
SPDX-FileCopyrightText: the secureCodeBox authors
3-
4-
SPDX-License-Identifier: Apache-2.0
5-
-->
6-
1+
---
2+
# SPDX-FileCopyrightText: the secureCodeBox authors
3+
#
4+
# SPDX-License-Identifier: Apache-2.0
5+
6+
title: "ADR-0005: Buying separate marketing oriented webpage"
7+
sidebar_label: "ADR-0005"
8+
---
79
# ADR-0005: Buying separate marketing oriented webpage
810

911
| <!-- --> | <!-- --> |

docs/adr/adr_0006.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,12 @@
1-
<!--
2-
SPDX-FileCopyrightText: the secureCodeBox authors
3-
4-
SPDX-License-Identifier: Apache-2.0
5-
-->
6-
7-
# ADR-0006: How We Want to Handle Versions in Our Documentation
1+
---
2+
# SPDX-FileCopyrightText: the secureCodeBox authors
3+
#
4+
# SPDX-License-Identifier: Apache-2.0
5+
6+
title: "ADR-0005: Buying separate marketing oriented webpage"
7+
sidebar_label: "ADR-0005"
8+
---
9+
# ADR-0005: Buying separate marketing oriented webpage
810

911
| <!-- --> | <!-- --> |
1012
|----------------|----------|

docs/adr/adr_0007.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
1-
<!--
2-
SPDX-FileCopyrightText: the secureCodeBox authors
3-
4-
SPDX-License-Identifier: Apache-2.0
5-
-->
6-
1+
---
2+
# SPDX-FileCopyrightText: the secureCodeBox authors
3+
#
4+
# SPDX-License-Identifier: Apache-2.0
5+
6+
title: "ADR-0007: Proposal How to Mark Findings With Hashes to Find Duplicates"
7+
sidebar_label: "ADR-0007"
8+
---
79
# ADR-0007: Proposal How to Mark Findings With Hashes to Find Duplicates
810

911
| <!-- --> | <!-- --> |

docs/adr/adr_0008.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
1-
<!--
2-
SPDX-FileCopyrightText: the secureCodeBox authors
3-
4-
SPDX-License-Identifier: Apache-2.0
5-
-->
6-
1+
---
2+
# SPDX-FileCopyrightText: the secureCodeBox authors
3+
#
4+
# SPDX-License-Identifier: Apache-2.0
5+
6+
title: "ADR-0008: Drop the Former Decision To Provide Versioned Documentation"
7+
sidebar_label: "ADR-0008"
8+
---
79
# ADR-0008: Drop the Former Decision To Provide Versioned Documentation
810

911
| <!-- --> | <!-- --> |

docs/adr/adr_0009.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
1-
<!--
2-
SPDX-FileCopyrightText: the secureCodeBox authors
3-
4-
SPDX-License-Identifier: Apache-2.0
5-
-->
6-
1+
---
2+
# SPDX-FileCopyrightText: the secureCodeBox authors
3+
#
4+
# SPDX-License-Identifier: Apache-2.0
5+
6+
title: "ADR-0009: Architecture for pre-populating the file system of scanners"
7+
sidebar_label: "ADR-0009"
8+
---
79
# ADR-0009: Architecture for pre-populating the file system of scanners
810

911
| <!-- --> | <!-- --> |

docs/adr/adr_0010.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
1-
<!--
2-
SPDX-FileCopyrightText: the secureCodeBox authors
3-
4-
SPDX-License-Identifier: Apache-2.0
5-
-->
6-
1+
---
2+
# SPDX-FileCopyrightText: the secureCodeBox authors
3+
#
4+
# SPDX-License-Identifier: Apache-2.0
5+
6+
title: "ADR-0010: Custom Inheritance Behavior for Affinity and Tolerations"
7+
sidebar_label: "ADR-0010"
8+
---
79
# ADR-0010: Custom Inheritance Behavior for Affinity and Tolerations
810

911
| <!-- --> | <!-- --> |

0 commit comments

Comments
 (0)