From e0892028d22f87477b5d9c0e3138f8be42a2949a Mon Sep 17 00:00:00 2001 From: Marcela Melara Date: Mon, 22 Jan 2024 14:59:22 -0800 Subject: [PATCH 1/3] Add common action items for the new predicate vetting process Signed-off-by: Marcela Melara --- docs/new_predicate_guidelines.md | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/docs/new_predicate_guidelines.md b/docs/new_predicate_guidelines.md index 689c4a82..b9d15cf2 100644 --- a/docs/new_predicate_guidelines.md +++ b/docs/new_predicate_guidelines.md @@ -52,6 +52,12 @@ specification for you. Our vetting process is simple. 1. Open a PR following [ITE-9] formatting guidelines. + - Add a the new predicate to the list of [existing predicates]. + - To generate Go/Python/Java language bindings for the new predicate, + include a [protobuf definition]. + - If the [predicateType] URI will be defined under the + https://in-toto.io/attestation namespace, submit a PR to add a line + to the [URL redirects list] for the in-toto.io domain. 2. The in-toto Attestation Framework maintainers will review the PR at the next maintainers meeting. 3. If accepted, the new predicate type will be included in our directory. @@ -59,7 +65,10 @@ Our vetting process is simple. [ITE-9]: https://github.com/in-toto/ITE/tree/master/ITE/9#document-format [Predicates]: ../spec/v1/predicate.md [RFC 3339]: https://tools.ietf.org/html/rfc3339 +[URL redirects list]: https://github.com/in-toto/in-toto.io/blob/master/public/_redirects [field types]: ../spec/v1/field_types.md -[existing predicates]: ../spec/predicates +[existing predicates]: ../spec/predicates/README/md [parsing rules]: ../spec/v1/README.md#parsing-rules +[predicateType]: ../spec/v1/predicate.md#fields +[protobuf definition]: ../protos/README.md [vetting process]: #vetting-process From 6967da53002040e1f7673b5dc3778fa95bb6aadb Mon Sep 17 00:00:00 2001 From: Marcela Melara Date: Mon, 22 Jan 2024 15:19:03 -0800 Subject: [PATCH 2/3] Fix typos in doc updates Signed-off-by: Marcela Melara --- docs/new_predicate_guidelines.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/new_predicate_guidelines.md b/docs/new_predicate_guidelines.md index b9d15cf2..2dd797f6 100644 --- a/docs/new_predicate_guidelines.md +++ b/docs/new_predicate_guidelines.md @@ -52,7 +52,7 @@ specification for you. Our vetting process is simple. 1. Open a PR following [ITE-9] formatting guidelines. - - Add a the new predicate to the list of [existing predicates]. + - Add the new predicate to the list of [existing predicates]. - To generate Go/Python/Java language bindings for the new predicate, include a [protobuf definition]. - If the [predicateType] URI will be defined under the @@ -67,7 +67,7 @@ Our vetting process is simple. [RFC 3339]: https://tools.ietf.org/html/rfc3339 [URL redirects list]: https://github.com/in-toto/in-toto.io/blob/master/public/_redirects [field types]: ../spec/v1/field_types.md -[existing predicates]: ../spec/predicates/README/md +[existing predicates]: ../spec/predicates/README.md [parsing rules]: ../spec/v1/README.md#parsing-rules [predicateType]: ../spec/v1/predicate.md#fields [protobuf definition]: ../protos/README.md From 50229f18b6da3bdf97a640308caa92361418aaaa Mon Sep 17 00:00:00 2001 From: Marcela Melara Date: Wed, 24 Jan 2024 09:20:38 -0800 Subject: [PATCH 3/3] Clarify predicate type redirect task Signed-off-by: Marcela Melara --- docs/new_predicate_guidelines.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/docs/new_predicate_guidelines.md b/docs/new_predicate_guidelines.md index 2dd797f6..559f9435 100644 --- a/docs/new_predicate_guidelines.md +++ b/docs/new_predicate_guidelines.md @@ -55,12 +55,14 @@ Our vetting process is simple. - Add the new predicate to the list of [existing predicates]. - To generate Go/Python/Java language bindings for the new predicate, include a [protobuf definition]. - - If the [predicateType] URI will be defined under the - https://in-toto.io/attestation namespace, submit a PR to add a line - to the [URL redirects list] for the in-toto.io domain. 2. The in-toto Attestation Framework maintainers will review the PR at the next maintainers meeting. 3. If accepted, the new predicate type will be included in our directory. +4. Finally, if the new [predicateType] URI is defined under the + https://in-toto.io/attestation namespace, submit a PR to add the following + line to the [URL redirects list] for the in-toto.io domain: + +`attestation// https://github.com/in-toto/attestation/tree/main/spec/predicates/.md` [ITE-9]: https://github.com/in-toto/ITE/tree/master/ITE/9#document-format [Predicates]: ../spec/v1/predicate.md