From c6acc0d7f241777f22cd2a552dc669ed637a0049 Mon Sep 17 00:00:00 2001 From: Miska Kaipiainen Date: Fri, 6 Nov 2020 15:39:02 +0200 Subject: [PATCH] New Documentation: Contributing section (#1266) Signed-off-by: Miska Kaipiainen --- docs/contributing/README.md | 18 +++++++++++++++++- docs/contributing/development.md | 3 +++ docs/contributing/documentation.md | 22 ++++++++++++++++++++++ docs/contributing/maintainers.md | 17 +++++++++++++++++ docs/contributing/promotion.md | 27 +++++++++++++++++++++++++++ 5 files changed, 86 insertions(+), 1 deletion(-) create mode 100644 docs/contributing/development.md create mode 100644 docs/contributing/documentation.md create mode 100644 docs/contributing/maintainers.md create mode 100644 docs/contributing/promotion.md diff --git a/docs/contributing/README.md b/docs/contributing/README.md index a0990367ef..13a6ca8c05 100644 --- a/docs/contributing/README.md +++ b/docs/contributing/README.md @@ -1 +1,17 @@ -TBD +# Contributing + +There are multiple ways you can contribute to Lens - even if you are not a developer, you can still contribute. We are always looking for assistance with creating or updating documentation, testing the application, reporting and troubleshooting issues. + +Here are some ideas how you can contribute! + +* [Development](./development.md) – Help making Lens better. +* [Maintaining the Project](./maintainers.md) – Become community maintainer and help us maintain the project. +* [Extension Development](../extensions) – Add integrations via Lens Extensions. +* [Documentation](./documentation.md) – Help improve Lens documentation. +* [Promotion](./promotion.md) – Show your support, be an ambassador to Lens, write blogs and make videos! + +If you are an influencer, blogger or journalist, feel free to [spread the word](./promotion.md)! + +## Code of Conduct + +This project adheres to the [Contributor Covenant](https://www.contributor-covenant.org/) code of conduct. By participating and contributing to Lens, you are expected to uphold this code. Please report unacceptable behaviour to info@k8slens.dev diff --git a/docs/contributing/development.md b/docs/contributing/development.md new file mode 100644 index 0000000000..8e5633cda9 --- /dev/null +++ b/docs/contributing/development.md @@ -0,0 +1,3 @@ +# Development + +TBD diff --git a/docs/contributing/documentation.md b/docs/contributing/documentation.md new file mode 100644 index 0000000000..00b9f9550e --- /dev/null +++ b/docs/contributing/documentation.md @@ -0,0 +1,22 @@ +# Documentation + +We are glad to see you are interested in contributing to Lens documentation. If this is the first Open Source project you will contribute to, we strongly suggest reading GitHub's excellent guide: [How to Contribute to Open Source](https://opensource.guide/how-to-contribute). + +## Finding Documentation Issues to Work On + +You can find a list of open documentation related issues [here](https://github.com/lensapp/lens/issues?q=is%3Aopen+is%3Aissue+label%3Aarea%2Fdocumentation). When you find something you would like to work on: + +1. Express your interest to start working on an issue via comments. +2. One of the maintainers will assign the issue for you. +3. You can start working on the issue. Once done, simply submit a pull request. + +## Requirements for Documentation Pull Requests + +When you create a new pull request, we expect some requirements to be met. + +* Follow this naming convention for Pull Requests: + * When adding new documentation, add `New Documentation:` before the title. E.g. `New Documentation: Getting Started` + * When fixing documentation, add `Fix Documentation:` before the title. E.g. `Fix Documentation: Getting Started` + * When updating documentation, add `Update Documentation:` before the title. E.g. `Update Documentation: Getting Started` +* If your Pull Request closes an issue you need to write `Closes #ISSUE_NUMBER` where the ISSUE_NUMBER is the number in the end of the link url that will link your pull request to the issue, when merged will close that issue. +* For each pull request made, we run tests to check if there are any broken links, the markdown formatting is valid and the linter is passing. diff --git a/docs/contributing/maintainers.md b/docs/contributing/maintainers.md new file mode 100644 index 0000000000..a73918b272 --- /dev/null +++ b/docs/contributing/maintainers.md @@ -0,0 +1,17 @@ +# Maintainers + +We are looking for community maintainers for the Lens project. Maintainers will be added to a special team with write permissions. These permissions consist of opening, closing, tagging and editing issues, and pull requests, as well as create and delete non protected branches. + +The responsibilities of a community maintainer are listed below. + +## Issues Triage + +* **Labeling Issues:** Label issues accordingly. +* **Finding Duplicates:** Finding and closing duplicate issues. +* **Doing First Level Contact:** Getting more information on the issues (like version number or asking for clarification) if needed. +* **Closing Irrelevant Issues:** Closing issues that are determined irrelevant, no longer needed, not relevant to the project and/or doesn't follow the issues guidelines. + +## Help with Contributions + +* **Help Manage Pull Requests:** Help the author of the pull request with any problems. +* **Contributing:** Create pull requests to help maintain and drive the project forward. diff --git a/docs/contributing/promotion.md b/docs/contributing/promotion.md new file mode 100644 index 0000000000..6f80ddb2b2 --- /dev/null +++ b/docs/contributing/promotion.md @@ -0,0 +1,27 @@ +# Promoting + +Help promote Lens! If you are not a developer (or even if you are), you can still contribute to the project, a lot, by helping us promote it. As we are a free open source project, the community is our most important asset, so here are some ways that you can help the project continue to grow. + +## Follow, Like, Recommend, Favorite, Vote and Star Us + +There are many sites where you can vote, recommend, favorite and star us. + +* [Twitter](https://twitter.com/k8slens) - Like, comment and retweet our posts, and follow us on Twitter +* [Medium](https://medium.com/k8slens) - Give claps to our articles and follow us on Medium +* [GitHub](https://github.com/lensapp/lens) - Become a stargazer on GitHub +* [StackShare](https://stackshare.io/lens) - Indicate you are using Lens and follow us on StackShare +* [Reddit](https://www.reddit.com/search/?q=lens%20kubernetes&sort=new) - Upvote and be an ambassador of Lens by participating relevant discussions on Reddit +* [Hacker News](https://hn.algolia.com/?dateRange=all&page=0&prefix=false&query=lens%20kubernetes&sort=byDate&type=story) - Upvote and be an ambassador of Lens by participating relevant discussions on Hacker News + +## Write Blogs or Make Videos About Us + +Here are some nice blog posts and videos about our project for you to get some inspiration: + +[Onboard AWS EKS Cluster on Lens(Kubernetes IDE)](https://dev.to/himwad05/onboard-aws-eks-cluster-on-lens-kubernetes-ide-492l) +[Using Lens to Manage All Your Kubernetes Cluster](https://medium.com/@magicmagnate/using-lens-to-manage-all-your-kubernetes-cluster-c1ef88fdb476) +[Kontena Lens - Beautiful Kubernetes UI](https://www.youtube.com/watch?v=YGgaiGdYfdI) +[Gerenciando Kubernetes com Lens e Octant](https://www.youtube.com/watch?v=h9ZqDelJLQQ) +[Walkthrough of Kubernetes IDE - Lens](https://www.youtube.com/watch?v=602aHZSdEfY) +[LENS - Interfaz Gráfica para Kubernetes en 1 PASO.](https://www.youtube.com/watch?v=DFMKcR4BqwM) + +Psst... If you have created some content around Lens, let us know!