From dd4d033cb80bf9191e5642d4a6118e3300d5fbb7 Mon Sep 17 00:00:00 2001 From: Ayush Gupta Date: Tue, 28 May 2024 16:36:37 +0530 Subject: [PATCH 1/2] Added blog contributions guidelines Signed-off-by: Ayush Gupta --- blog-contributions-guidelines.md | 57 ++++++++++++++++++++++++++++++++ 1 file changed, 57 insertions(+) create mode 100644 blog-contributions-guidelines.md diff --git a/blog-contributions-guidelines.md b/blog-contributions-guidelines.md new file mode 100644 index 0000000..4f56f56 --- /dev/null +++ b/blog-contributions-guidelines.md @@ -0,0 +1,57 @@ +# How to get started contributing to the in-toto blog + +Welcome to the in-toto community blog. This blog serves as an educational resource for community members, maintainers,users and contributors. + +The process is meant to be self-serve but if you experience any difficulties reach out to us at contact us via the [CNCF Slack on the #in-toto](https://cloud-native.slack.com/archives/C8NMD3QJ3) channel. + +**TLDR;** submit your blog Pull Request [here](https://github.com/in-toto/in-toto.github.io). + +Please read and follow the guidelines. Incomplete submissions will be rejected. + +**Content criteria & guidelines** +The community thanks you for your interest in contributing content to the TUF community blog. Here are examples of content to create and criteria to follow to avoid rejection. + +**Articles about The Update Framework** +* Technical content and how-to’s. +* Stories about in-toto how in-toto helped. +* Use cases and success stories about in-toto. +* Industry insight into in-toto and in-toto’s role in the ecosystem +* Industry insight about software update system security and how to use TUF +* Project updates about in-toto. + + + +Next, the blog editor will review the content for any grammatical errors, spelling mistakes, technical accuracy, and provide feedback. All feedback and collaboration will take place in the Github Pull Request. + +Depending on where your blog falls in the queue, editing and publication dates will vary. Blog content is reviewed and published on a first come, first serve basis. This step should take 5 - 7 business days to complete. + +The goal is to publish 1 blog per week and the community commits to a 2 week(s) turnaround end to end. + +**Publishing process** +* Depending on the quality of the content & edits needed this process should take 5 - 10 business days. +* Once the editor and contributor are done with the editing process, the blog should publish when the next available slot opens up. +* See editorial calendar +* Community contributed blogs are published on Tuesday & Thursday on a first come, first serve basis. +* The blog content is published on the in-toto [website](https://in-toto.io/). + +**Submit your PR** +Now that you understand the content guidelines and publishing process you are ready to submit your pull request. All blog content must be submitted through this process to be considered for publication. +* How to submit your first PR blog in easy steps +* Step 1: Fork to the [in-tot website repo](https://github.com/in-toto/in-toto.github.io) on Github +* Step 2: Clone locally your branch and create a new branch +* Step 3: Create your blog post in markdown format. +* Step 4: Add images to the [img folder](https://github.com/in-toto/in-toto.github.io/tree/master/assets/images) +* Step 4: Commit your work with a signoff and push to Github +* Step 5: Create your pull request to upstream repo with your changes +Filing your first PR? Go here 👉 [for step by step instructions ](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request) + +**Promoting your blog** +Finally, once the blog goes live we will promote the content on the in-toto social media handle. + +Be sure to provide a headshot and your social media handles so we can tag you in the post. Don’t forget to share your content with your network too! + +Blog content will also be submitted for promotion in the following channels: +* [in-toto Slack channel](https://cloud-native.slack.com/archives/C8NMD3QJ3) +* [in-toto Newsletter]() +* [in-toto Twitter handle]() +* [in-toto LinkedIn page]() \ No newline at end of file From 200f46b240e83a42e4fe4a2332d6c3865748939b Mon Sep 17 00:00:00 2001 From: Ayush Gupta <114745463+Ayush9026@users.noreply.github.com> Date: Wed, 29 May 2024 16:34:45 +0530 Subject: [PATCH 2/2] Update blog-contributions-guidelines.md --- blog-contributions-guidelines.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/blog-contributions-guidelines.md b/blog-contributions-guidelines.md index 4f56f56..219368f 100644 --- a/blog-contributions-guidelines.md +++ b/blog-contributions-guidelines.md @@ -9,7 +9,7 @@ The process is meant to be self-serve but if you experience any difficulties rea Please read and follow the guidelines. Incomplete submissions will be rejected. **Content criteria & guidelines** -The community thanks you for your interest in contributing content to the TUF community blog. Here are examples of content to create and criteria to follow to avoid rejection. +The community thanks you for your interest in contributing content to the in-toto community blog. Here are examples of content to create and criteria to follow to avoid rejection. **Articles about The Update Framework** * Technical content and how-to’s. @@ -54,4 +54,4 @@ Blog content will also be submitted for promotion in the following channels: * [in-toto Slack channel](https://cloud-native.slack.com/archives/C8NMD3QJ3) * [in-toto Newsletter]() * [in-toto Twitter handle]() -* [in-toto LinkedIn page]() \ No newline at end of file +* [in-toto LinkedIn page]()