From 168a168772b9edda6e336e92581e718c55acdb99 Mon Sep 17 00:00:00 2001 From: Justin Cappos Date: Thu, 2 May 2024 20:40:56 -0400 Subject: [PATCH 1/5] Update project_ideas.md Signed-off-by: Justin Cappos --- .../2024/02-Jun-Aug/project_ideas.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/programs/lfx-mentorship/2024/02-Jun-Aug/project_ideas.md b/programs/lfx-mentorship/2024/02-Jun-Aug/project_ideas.md index e9b1e030..89c62040 100644 --- a/programs/lfx-mentorship/2024/02-Jun-Aug/project_ideas.md +++ b/programs/lfx-mentorship/2024/02-Jun-Aug/project_ideas.md @@ -188,3 +188,22 @@ Onboarding new end users into a sophisticated system like Knative Eventing prese - Frances Thai @notfelineit frances@planetscale.com - Upstream Issue (URL): https://github.com/vitessio/arewefastyet/issues/525 + +### TUF + +#### Documentation assessment and improvements + +- Description: + - Open source projects need help with their documentation! The TUF project is a good place to start. We'd welcome help from others to help here +and become contributors to other projects / TAGs later in the project period. +- Expected Outcome: + - Both an improvement of project docs and the development of a new contributor. A student will understand how to do technical writing for an open source project. +- Recommended Skills: + - Technical writing + - Basic understanding of security principles +- Mentor(s): + - Justin Cappos @JustinCappos jcappos@nyu.edu + - LF documentation wizard (to be named later) +- Upstream Issues: + - https://github.com/cncf/techdocs/issues/162 + From 81ecd93e8127f2c96daefa7677984d019c18f99b Mon Sep 17 00:00:00 2001 From: Justin Cappos Date: Tue, 7 May 2024 11:26:10 -0400 Subject: [PATCH 2/5] Update programs/lfx-mentorship/2024/02-Jun-Aug/project_ideas.md Signed-off-by: Justin Cappos --- programs/lfx-mentorship/2024/02-Jun-Aug/project_ideas.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/programs/lfx-mentorship/2024/02-Jun-Aug/project_ideas.md b/programs/lfx-mentorship/2024/02-Jun-Aug/project_ideas.md index 89c62040..876adf78 100644 --- a/programs/lfx-mentorship/2024/02-Jun-Aug/project_ideas.md +++ b/programs/lfx-mentorship/2024/02-Jun-Aug/project_ideas.md @@ -195,7 +195,7 @@ Onboarding new end users into a sophisticated system like Knative Eventing prese - Description: - Open source projects need help with their documentation! The TUF project is a good place to start. We'd welcome help from others to help here -and become contributors to other projects / TAGs later in the project period. +and become contributors to other projects / TAGs later in the project period. The student will (with minimal guidance from the CNCF team and TUF project) do a CNCF assessment for the TUF documentation - Expected Outcome: - Both an improvement of project docs and the development of a new contributor. A student will understand how to do technical writing for an open source project. - Recommended Skills: From 2d7d26e53d5401f92f6ea6b5f00a30abeda9938c Mon Sep 17 00:00:00 2001 From: Ali Ok Date: Wed, 8 May 2024 09:44:34 +0300 Subject: [PATCH 3/5] Update project_ideas.md Signed-off-by: Ali Ok --- programs/lfx-mentorship/2024/02-Jun-Aug/project_ideas.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/programs/lfx-mentorship/2024/02-Jun-Aug/project_ideas.md b/programs/lfx-mentorship/2024/02-Jun-Aug/project_ideas.md index 2044af52..4a85c6a5 100644 --- a/programs/lfx-mentorship/2024/02-Jun-Aug/project_ideas.md +++ b/programs/lfx-mentorship/2024/02-Jun-Aug/project_ideas.md @@ -270,9 +270,9 @@ fundamentals, familiarity with [sigstore](https://www.sigstore.dev/), - Description: - Open source projects need help with their documentation! The TUF project is a good place to start. We'd welcome help from others to help here -and become contributors to other projects / TAGs later in the project period. The student will (with minimal guidance from the CNCF team and TUF project) do a CNCF assessment for the TUF documentation +and become contributors to other projects / TAGs later in the project period. The mentee will (with minimal guidance from the CNCF team and TUF project) do a CNCF assessment for the TUF documentation - Expected Outcome: - - Both an improvement of project docs and the development of a new contributor. A student will understand how to do technical writing for an open source project. + - Both an improvement of project docs and the development of a new contributor. A mentee will understand how to do technical writing for an open source project. - Recommended Skills: - Technical writing - Basic understanding of security principles @@ -361,4 +361,4 @@ and become contributors to other projects / TAGs later in the project period. T - Mentor(s): - Shiming Zhang (wzshiming, ) - Zhenghao Zhu (Zhuzhenghao, ) -- Upstream Issue: https://github.com/kubernetes-sigs/kwok/issues/1063 \ No newline at end of file +- Upstream Issue: https://github.com/kubernetes-sigs/kwok/issues/1063 From ed3d505c5c2db4775d9e4613e7297dcbacaebf6a Mon Sep 17 00:00:00 2001 From: Ali Ok Date: Wed, 8 May 2024 22:35:14 +0300 Subject: [PATCH 4/5] Update programs/lfx-mentorship/2024/02-Jun-Aug/project_ideas.md Co-authored-by: Patrice Chalin Signed-off-by: Ali Ok --- programs/lfx-mentorship/2024/02-Jun-Aug/project_ideas.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/programs/lfx-mentorship/2024/02-Jun-Aug/project_ideas.md b/programs/lfx-mentorship/2024/02-Jun-Aug/project_ideas.md index 4a85c6a5..93909306 100644 --- a/programs/lfx-mentorship/2024/02-Jun-Aug/project_ideas.md +++ b/programs/lfx-mentorship/2024/02-Jun-Aug/project_ideas.md @@ -278,7 +278,7 @@ and become contributors to other projects / TAGs later in the project period. T - Basic understanding of security principles - Mentor(s): - Justin Cappos @JustinCappos jcappos@nyu.edu - - LF documentation wizard (to be named later) + - Patrice Chalin @chalin chalin@cncf.io - Upstream Issues: - https://github.com/cncf/techdocs/issues/162 From 937950146763928a56ff76e062594803175cb819 Mon Sep 17 00:00:00 2001 From: Ali Ok Date: Wed, 8 May 2024 22:35:25 +0300 Subject: [PATCH 5/5] Update programs/lfx-mentorship/2024/02-Jun-Aug/project_ideas.md Co-authored-by: Patrice Chalin Signed-off-by: Ali Ok --- programs/lfx-mentorship/2024/02-Jun-Aug/project_ideas.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/programs/lfx-mentorship/2024/02-Jun-Aug/project_ideas.md b/programs/lfx-mentorship/2024/02-Jun-Aug/project_ideas.md index 93909306..34710fb2 100644 --- a/programs/lfx-mentorship/2024/02-Jun-Aug/project_ideas.md +++ b/programs/lfx-mentorship/2024/02-Jun-Aug/project_ideas.md @@ -270,7 +270,7 @@ fundamentals, familiarity with [sigstore](https://www.sigstore.dev/), - Description: - Open source projects need help with their documentation! The TUF project is a good place to start. We'd welcome help from others to help here -and become contributors to other projects / TAGs later in the project period. The mentee will (with minimal guidance from the CNCF team and TUF project) do a CNCF assessment for the TUF documentation +and become contributors to other projects / TAGs later in the project period. The mentee will (with minimal guidance from the CNCF team and TUF project) do a [CNCF assessment](https://github.com/cncf/techdocs/blob/main/assessments/howto.md) for the TUF documentation - Expected Outcome: - Both an improvement of project docs and the development of a new contributor. A mentee will understand how to do technical writing for an open source project. - Recommended Skills: