From f4af5d4d15bd1235c5486dc2205df9083e14be05 Mon Sep 17 00:00:00 2001 From: olangen Date: Fri, 12 May 2023 08:06:49 +0000 Subject: [PATCH 1/3] Correcting namespace format rules in catalog documentation Signed-off-by: olangen --- .../software-catalog/descriptor-format.md | 18 +++++++++++------- 1 file changed, 11 insertions(+), 7 deletions(-) diff --git a/docs/features/software-catalog/descriptor-format.md b/docs/features/software-catalog/descriptor-format.md index 9fb57cb82f..a2f7001c2e 100644 --- a/docs/features/software-catalog/descriptor-format.md +++ b/docs/features/software-catalog/descriptor-format.md @@ -239,18 +239,22 @@ Example: `visits-tracking-service`, `CircleciBuildsDumpV2_avro_gcs` ### `namespace` [optional] -The ID of a namespace that the entity belongs to. This is a string that follows -the same format restrictions as `name` above. +The ID of a namespace that the entity belongs to. This field is optional, and +currently has no special semantics apart from bounding the name uniqueness +constraint if specified. It is reserved for future use and may get broader +semantic implication later. -This field is optional, and currently has no special semantics apart from -bounding the name uniqueness constraint if specified. It is reserved for future -use and may get broader semantic implication later. For now, it is recommended -to not specify a namespace unless you have specific need to do so. This means -the entity belongs to the `"default"` namespace. +For now, it is recommended to not specify a namespace unless you have specific +need to do so. This means the entity belongs to the `"default"` namespace. Namespaces may also be part of the catalog, and are `v1` / `Namespace` entities, i.e. not Backstage specific but the same as in Kubernetes. +Namespaces must be sequences of `[a-zA-Z0-9]`, possibly separated by `-`, at +most 63 characters in total. + +Example: `tracking-services`, `CircleciV2-Entities` + ### `uid` [output] Each entity gets an automatically generated globally unique ID when it first From 9d04d982757604183e9cc6814b9f48872380789a Mon Sep 17 00:00:00 2001 From: Oliver Langen <128791938+langeno@users.noreply.github.com> Date: Fri, 12 May 2023 13:46:07 +0200 Subject: [PATCH 2/3] Apply suggestions from code review Co-authored-by: Johan Haals Signed-off-by: Oliver Langen <128791938+langeno@users.noreply.github.com> --- docs/features/software-catalog/descriptor-format.md | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/docs/features/software-catalog/descriptor-format.md b/docs/features/software-catalog/descriptor-format.md index a2f7001c2e..c2202e33dd 100644 --- a/docs/features/software-catalog/descriptor-format.md +++ b/docs/features/software-catalog/descriptor-format.md @@ -247,13 +247,11 @@ semantic implication later. For now, it is recommended to not specify a namespace unless you have specific need to do so. This means the entity belongs to the `"default"` namespace. -Namespaces may also be part of the catalog, and are `v1` / `Namespace` entities, -i.e. not Backstage specific but the same as in Kubernetes. Namespaces must be sequences of `[a-zA-Z0-9]`, possibly separated by `-`, at -most 63 characters in total. +most 63 characters in total. Namespace names are case insensitive and will be rendered as lower case in most places. -Example: `tracking-services`, `CircleciV2-Entities` +Example: `tracking-services`, `payment` ### `uid` [output] From 7c5431c4136333e9601975491d63a9dfa39b4168 Mon Sep 17 00:00:00 2001 From: olangen Date: Sat, 13 May 2023 13:35:30 +0000 Subject: [PATCH 3/3] Run prettier on descripted-format.md Signed-off-by: olangen --- docs/features/software-catalog/descriptor-format.md | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/features/software-catalog/descriptor-format.md b/docs/features/software-catalog/descriptor-format.md index c2202e33dd..1c9825d5ca 100644 --- a/docs/features/software-catalog/descriptor-format.md +++ b/docs/features/software-catalog/descriptor-format.md @@ -247,7 +247,6 @@ semantic implication later. For now, it is recommended to not specify a namespace unless you have specific need to do so. This means the entity belongs to the `"default"` namespace. - Namespaces must be sequences of `[a-zA-Z0-9]`, possibly separated by `-`, at most 63 characters in total. Namespace names are case insensitive and will be rendered as lower case in most places.