From 18987ca3ec01be861555fd3fd3a09e3376287b49 Mon Sep 17 00:00:00 2001 From: Lenny Goodell Date: Mon, 15 Aug 2022 13:53:21 -0700 Subject: [PATCH] fix: Rename the existing UCR to not have leading sequence number (#837) * fix: Rename the existing UCR to not have leading sequence number Also added notes to TOC on naming and order of UCRs and ADRs Signed-off-by: Leonard Goodell --- docs_src/design/TOC.md | 7 +++++++ ...-Events-for-Devices.md => System-Events-for-Devices.md} | 0 2 files changed, 7 insertions(+) rename docs_src/design/ucr/{0001-System-Events-for-Devices.md => System-Events-for-Devices.md} (100%) diff --git a/docs_src/design/TOC.md b/docs_src/design/TOC.md index 86825f8186..ec253c5363 100644 --- a/docs_src/design/TOC.md +++ b/docs_src/design/TOC.md @@ -1,6 +1,10 @@ # Use Cases and Design Records ## Use Case Records (UCRs) + +!!! note + UCRs are listed in alphabetical order by title. + | Name/Link | Short Description | |---------------------------------------------------------------------------|---------------------------------------------------------------| | [Provision Watch via Device Metadata](./ucr/Provision-Watch-via-Device-Metadata.md) | Use Case for Provision Watching via Additional Device Metadata | @@ -8,6 +12,9 @@ ## Architectural Design Records (ADRs) +!!! note + ADRs are listed in chronological order by sequence number in title. + | Name/Link | Short Description | | ------------------------------------------------------------ | ------------------------------------------------------------ | | [0001 Registry Refactor](./adr/0001-Registy-Refactor.md) | Separate out Registry and Configuration APIs | diff --git a/docs_src/design/ucr/0001-System-Events-for-Devices.md b/docs_src/design/ucr/System-Events-for-Devices.md similarity index 100% rename from docs_src/design/ucr/0001-System-Events-for-Devices.md rename to docs_src/design/ucr/System-Events-for-Devices.md