From c04d4bcc9dde841803ac83ada3ce98c3b5a9efe8 Mon Sep 17 00:00:00 2001 From: Tyler Wray Date: Tue, 13 Feb 2024 15:30:53 -0700 Subject: [PATCH 1/5] Update descriptor-format.md Adding table for profile fields. Signed-off-by: Tyler Wray --- .../software-catalog/descriptor-format.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/docs/features/software-catalog/descriptor-format.md b/docs/features/software-catalog/descriptor-format.md index cc2b3d1c7b..9adfe47841 100644 --- a/docs/features/software-catalog/descriptor-format.md +++ b/docs/features/software-catalog/descriptor-format.md @@ -955,6 +955,14 @@ some form, that the group may wish to be used for contacting them. The picture is expected to be a URL pointing to an image that's representative of the group, and that a browser could fetch and render on a group page or similar. +The fields of a profile are: + +| Field | Type | Description | +| ------------------------ | ------ | -------------------------------------------------------------- | +| `displayName` (optional) | String | A human-readable name for the group. | +| `email` (optional) | String | An email the group may wish to be used for contacting them. | +| `picture` (optional) | String | A URL pointing to an image that's representative of the group. | + ### `spec.parent` [optional] The immediate parent group in the hierarchy, if any. Not all groups must have a @@ -1040,6 +1048,14 @@ of some form, that the user may wish to be used for contacting them. The picture is expected to be a URL pointing to an image that's representative of the user, and that a browser could fetch and render on a profile page or similar. +The fields of a profile are: + +| Field | Type | Description | +| ------------------------ | ------ | -------------------------------------------------------------- | +| `displayName` (optional) | String | A human-readable name for the group. | +| `email` (optional) | String | An email the group may wish to be used for contacting them. | +| `picture` (optional) | String | A URL pointing to an image that's representative of the group. | + ### `spec.memberOf` [required] The list of groups that the user is a direct member of (i.e., no transitive From 9bb9a4806c2a0e39db195e1ff20fb683dbb00d03 Mon Sep 17 00:00:00 2001 From: Tyler Wray Date: Tue, 13 Feb 2024 19:19:30 -0700 Subject: [PATCH 2/5] Update docs/features/software-catalog/descriptor-format.md Co-authored-by: Andre Wanlin <67169551+awanlin@users.noreply.github.com> Signed-off-by: Tyler Wray --- docs/features/software-catalog/descriptor-format.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/features/software-catalog/descriptor-format.md b/docs/features/software-catalog/descriptor-format.md index 9adfe47841..4b54f648f8 100644 --- a/docs/features/software-catalog/descriptor-format.md +++ b/docs/features/software-catalog/descriptor-format.md @@ -1054,7 +1054,7 @@ The fields of a profile are: | ------------------------ | ------ | -------------------------------------------------------------- | | `displayName` (optional) | String | A human-readable name for the group. | | `email` (optional) | String | An email the group may wish to be used for contacting them. | -| `picture` (optional) | String | A URL pointing to an image that's representative of the group. | +| `picture` (optional) | String | A URL pointing to an image that's representative of the user. | ### `spec.memberOf` [required] From f095b4b892971011676930aebfeaa0fb1d7e318b Mon Sep 17 00:00:00 2001 From: Tyler Wray Date: Tue, 13 Feb 2024 19:19:33 -0700 Subject: [PATCH 3/5] Update docs/features/software-catalog/descriptor-format.md Co-authored-by: Andre Wanlin <67169551+awanlin@users.noreply.github.com> Signed-off-by: Tyler Wray --- docs/features/software-catalog/descriptor-format.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/features/software-catalog/descriptor-format.md b/docs/features/software-catalog/descriptor-format.md index 4b54f648f8..b0d74f8ab2 100644 --- a/docs/features/software-catalog/descriptor-format.md +++ b/docs/features/software-catalog/descriptor-format.md @@ -1053,7 +1053,7 @@ The fields of a profile are: | Field | Type | Description | | ------------------------ | ------ | -------------------------------------------------------------- | | `displayName` (optional) | String | A human-readable name for the group. | -| `email` (optional) | String | An email the group may wish to be used for contacting them. | +| `email` (optional) | String | An email the user may wish to be used for contacting them. | | `picture` (optional) | String | A URL pointing to an image that's representative of the user. | ### `spec.memberOf` [required] From f321ad476632eef5a5b9271c3a55d174f20fcf3d Mon Sep 17 00:00:00 2001 From: Tyler Wray Date: Tue, 13 Feb 2024 19:19:41 -0700 Subject: [PATCH 4/5] Update docs/features/software-catalog/descriptor-format.md Co-authored-by: Andre Wanlin <67169551+awanlin@users.noreply.github.com> Signed-off-by: Tyler Wray --- docs/features/software-catalog/descriptor-format.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/features/software-catalog/descriptor-format.md b/docs/features/software-catalog/descriptor-format.md index b0d74f8ab2..41bd81019b 100644 --- a/docs/features/software-catalog/descriptor-format.md +++ b/docs/features/software-catalog/descriptor-format.md @@ -1052,7 +1052,7 @@ The fields of a profile are: | Field | Type | Description | | ------------------------ | ------ | -------------------------------------------------------------- | -| `displayName` (optional) | String | A human-readable name for the group. | +| `displayName` (optional) | String | A human-readable name for the user. | | `email` (optional) | String | An email the user may wish to be used for contacting them. | | `picture` (optional) | String | A URL pointing to an image that's representative of the user. | From 202557f723496e5615abd3fa6e2a98c40d424769 Mon Sep 17 00:00:00 2001 From: blam Date: Wed, 21 Feb 2024 13:09:09 +0100 Subject: [PATCH 5/5] chore: make pretty Signed-off-by: blam --- docs/features/software-catalog/descriptor-format.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/features/software-catalog/descriptor-format.md b/docs/features/software-catalog/descriptor-format.md index 41bd81019b..5eae22581d 100644 --- a/docs/features/software-catalog/descriptor-format.md +++ b/docs/features/software-catalog/descriptor-format.md @@ -1050,8 +1050,8 @@ and that a browser could fetch and render on a profile page or similar. The fields of a profile are: -| Field | Type | Description | -| ------------------------ | ------ | -------------------------------------------------------------- | +| Field | Type | Description | +| ------------------------ | ------ | ------------------------------------------------------------- | | `displayName` (optional) | String | A human-readable name for the user. | | `email` (optional) | String | An email the user may wish to be used for contacting them. | | `picture` (optional) | String | A URL pointing to an image that's representative of the user. |