From 40784a1e01228aa5164c6471b774b7023986190d Mon Sep 17 00:00:00 2001 From: Anton Gilgur Date: Sat, 11 May 2024 11:20:56 -0400 Subject: [PATCH 1/2] docs: moved, not deprecated - the repo has moved, the project is not deprecated - this was confusing to users, as reported in Workflows and in the new Piper repo - fix the language/wording to say "moved" and _not_ "deprecated" Signed-off-by: Anton Gilgur --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 3f806f6..314e4f0 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ -# Piper - Deprecated +# Piper - MOVED -⚠️ **Important Notice:** This project (Piper) is no longer actively maintained. We have moved to a new and improved repository for Piper. Please visit the following link for the latest updates and contributions: +⚠️ **Important Notice:** Piper has moved to a new and improved repository. Please visit the following link for the latest updates and contributions: [New repository](https://github.com/quickube/piper) From 4c1f27018d6d03b182ea2aa882cf5b23edcd1261 Mon Sep 17 00:00:00 2001 From: Anton Gilgur Date: Sat, 11 May 2024 11:23:11 -0400 Subject: [PATCH 2/2] markdownlint fixes Signed-off-by: Anton Gilgur --- README.md | 11 ++++------- 1 file changed, 4 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 314e4f0..3715f64 100644 --- a/README.md +++ b/README.md @@ -13,6 +13,7 @@ Thank you for your support and understanding. Happy coding! [New Piper Repository](https://github.com/quickube/piper) + ## Table of Contents - [Getting Started](#getting-started) @@ -22,9 +23,9 @@ Happy coding! ## Getting Started -Piper configures a webhook in git provider and listens to the webhooks sends. It will create a Workflow CRD out of branches that contains `.workflows` folder. -This folder should contain declarations of the templates and main DAG that will be running. -Finally, it will submit the Workflow as a K8s resource in the cluster. +Piper configures a webhook in git provider and listens to the webhooks sends. It will create a Workflow CRD out of branches that contains `.workflows` folder. +This folder should contain declarations of the templates and main DAG that will be running. +Finally, it will submit the Workflow as a K8s resource in the cluster. To access more detailed explanations, please navigate to the [Documentation site](https://piper.rookout.com). https://github.com/Rookout/piper/assets/106976988/09b3a5d8-3428-4bdc-9146-3034d81164bf @@ -39,7 +40,6 @@ If you encounter any issues or bugs while using Piper, please help us improve by 4. Add appropriate labels to categorize the issue (e.g., bug, enhancement, question). 5. Submit the issue, and our team will review and address it as soon as possible. - ## How to Contribute If you're interested in contributing to this project, please feel free to submit a pull request. We welcome all contributions and feedback. @@ -48,6 +48,3 @@ Please check out our [Contribution guidelines for this project](docs/CONTRIBUTIN ## License This project is licensed under the Apache License. Please see the [LICENSE](LICENSE) file for details. - - -