feat: add contribution guidelines (#616)

* feat(contribution): add contribution.md

* feat(docs) add contribution docs

* feat(docs): add base contribution docs

* feat(docs): add ochestra guidelines

* feat(docs): add docs guidelines

* feat(docs): add code of conduct

* feat(docs): rename ochestra to kestra

* feat(docs): use sentence case

* nitpick(docs): update the grammar

* feat(image): update image url

---------

Co-authored-by: Ridge Kimani <[email protected]>

.github/CODE_OF_CONDUCT.md

@@ -0,0 +1,114 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[email protected].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior,  harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+

.github/CONTRIBUTING.md

@@ -0,0 +1,63 @@
+## Code of conduct
+
+This project and everyone participating in it is governed by the
+[Kestra Code of Conduct](https://github.com/kestra-io/docs/blob/main/.github/CODE_OF_CONDUCT.md).
+By participating, you are expected to uphold this code. Please report unacceptable behavior
+to [[email protected]](mailto:[email protected])
+
+## I want to contribute
+
+> ### Legal notice
+> When contributing to this project, you must agree that you have authored 100% of the content, that you have the necessary rights to the content and that the content you contribute may be provided under the project license.
+
+
+### Submit issues
+
+### Reporting bugs
+Bug reports help us make Kestra better for everyone. We provide a preconfigured template for bugs to make it very clear what information we need.
+Please search within our [already reported bugs](https://github.com/kestra-io/docs/issues?q=is%3Aissue+is%3Aopen+label%3Abug) before raising a new one to make sure you're not raising a duplicate.
+
+### Reporting security issues
+Please do not create a public GitHub issue. If you've found a security issue, please email us directly at [email protected] instead of raising an issue.
+
+
+### Requesting new features
+To request new features, please create an issue on this project.
+If you would like to suggest a new feature, we ask that you please use our issue template. It contains a few essential questions that help us understand the problem you are looking to solve and how you think your recommendation will address it.
+To see what has already been proposed by the community, you can look [here](https://github.com/kestra-io/docs/issues?q=is%3Aissue+is%3Aopen+label%3Aenhancement).
+Watch out for duplicates! If you are creating a new issue, please check existing open, or recently closed. Having a single voted for issue is far easier for us to prioritize.
+
+### Your first code contribution
+
+#### Requirements
+The following dependencies are required to build Kestra docs locally:
+- Node 14+ and npm
+- an IDE (Webstorm or VS Code)
+
+To start contributing:
+- [Fork](https://docs.github.com/en/github/getting-started-with-github/fork-a-repo) the repository
+- Clone the fork on your workstation:
+
+```shell
+$ git clone [email protected]:{YOUR_USERNAME}/docs.git
+$ cd docs
+```
+
+
+#### Develop
+The frontend is made with [Nuxt JS](https://nuxt.com/).
+
+```bash
+# install dependencies
+$ npm install
+
+# serve with hot reload at localhost:3001
+$ npm run dev
+
+# to generate static pages
+$ npm run generate
+
+
+# making a production build
+$ npm run build
+```

content/docs/13.contributing/01.code-of-conduct.md

@@ -0,0 +1,31 @@
+
+This project and everyone participating in it is governed by the
+[Kestra Code of Conduct](https://github.com/kestra-io/kestra/blob/develop/.github/CODE_OF_CONDUCT.md).
+By participating, you are expected to uphold this code. Please report unacceptable behavior
+to [[email protected]](mailto:[email protected]).
+
+
+### Legal Notice
+> When contributing to this project, you must agree that you have authored 100% of the content, that you have the necessary rights to the content and that the content you contribute may be provided under the project license.
+
+
+### Submit issues
+To submit features and bugs, please create them at the [issues](https://github.com/kestra-io/kestra/issues) page.
+
+### Reporting bugs
+Bug reports help us make Kestra better for everyone. We provide a preconfigured template for bugs to make it very clear what information we need.
+Please search within our [already reported bugs](https://github.com/kestra-io/kestra/issues?q=is%3Aissue+is%3Aopen+label%3Abug) before raising a new one to make sure you're not raising a duplicate.
+
+### Reporting security issues
+Please do not create a public GitHub issue. If you've found a security issue, please email us directly at [[email protected]](mailto:[email protected]) instead of raising an issue.
+
+
+### Requesting new features
+To request new features, please create an issue on this project.
+If you would like to suggest a new feature, we ask that you please use our issue template. It contains a few essential questions that help us understand the problem you are looking to solve and how you think your recommendation will address it.
+To see what has already been proposed by the community, you can look [here](https://github.com/kestra-io/kestra/issues?q=is%3Aissue+is%3Aopen+label%3Aenhancement).
+Watch out for duplicates! If you are creating a new issue, please check existing open, or recently closed. Having a single voted for issue is far easier for us to prioritize.
+
+
+### Your First Code Contribution
+Get started with contributing to the [orchestra](./02.kestra.md) and [docs](./03.docs.md) for Kestra.

content/docs/13.contributing/02.kestra.md

@@ -0,0 +1,71 @@
+---
+title: Kestra
+---
+
+#### Requirements
+The following dependencies are required to build Kestra locally:
+- Java 17+, Kestra runs on Java 11 but we hit a Java compiler bug fixed in Java 17
+- Node 14+ and npm
+- Python 3, pip and python venv
+- Docker & Docker Compose
+- an IDE (Intellij IDEA, Eclipse or VS Code)
+
+To start contributing:
+- [Fork](https://github.com/kestra-io/kestra/fork) the repository
+- Clone the fork on your workstation:
+
+```shell
+$ git clone [email protected]:{YOUR_USERNAME}/kestra.git
+$ cd kestra
+```
+
+#### Develop backend
+The backend is made with [Micronaut](https://micronaut.io).
+
+Open the cloned repository in your favorite IDE. In many IDEs, Gradle build will be detected and all dependencies will be downloaded.
+You can also build it from a terminal using `./gradlew build`, the Gradle wrapper will download the right Gradle version to use.
+
+- You may need to enable Java annotation processors since we are using it a lot.
+- The main class is `io.kestra.cli.App` from module `kestra.cli.main`
+- Pass as program arguments the server you want to develop, for example `server standalone` will start a [standalone Kestra server](https://kestra.io/docs/administrator-guide/servers/#kestra-standalone-development-environment-servers).
+- The Intellij Idea configuration can be found in screenshot below:
+![Intellij Idea Configuration ](/docs/contribution/standalone.png)
+  - `MICRONAUT_ENVIRONMENTS`: can be set any string and will load a custom configuration file in `cli/src/main/resources/application-{env}.yml`.
+  - `KESTRA_PLUGINS_PATH`: is the path where you will save plugins as Jar and will be loaded during the startup process.
+- You can also use the gradle task `./gradlew runStandalone` that will run a standalone server with `MICRONAUT_ENVIRONMENTS=override` and plugins path `local/plugins`
+- The server start by default on port 8080 and is reachable on `http://localhost:8080`.
+
+If you want to launch all tests, you need Python and some packages installed on your machine. On Ubuntu, you can install them with the following command:
+
+```shell
+$ sudo apt install python3 pip python3-venv
+$ python3 -m pip install virtualenv
+```
+
+
+#### Develop frontend
+The frontend is made with [Vue.js](https://vuejs.org/) and located in the `/ui` folder.
+
+```shell
+# install dependencies
+$ npm install
+```
+- Create a file `ui/.env.development.local` with the content `VITE_APP_API_URL=http://localhost:8080` (or your actual server URL).
+
+- You can serve the UI with hot reload at http://localhost:5173 using the command: `npm run dev`. For a production build, use: `npm run build`.
+
+- If you have CORS restrictions when using the local development npm server, you need to configure the backend to allow the http://localhost:5173 origin in `cli/src/main/resources/application-override.yml` using the following addition to your kestra configuration YAML definition:
+
+```yaml
+micronaut:
+  server:
+    cors:
+      enabled: true
+      configurations:
+        all:
+          allowedOrigins:
+            - http://localhost:5173
+```
+
+#### Develop plugins
+A complete documentation for developing a plugin can be found in the [Plugin Developer Guide](../plugin-developer-guide/).

content/docs/13.contributing/03.docs.md

@@ -0,0 +1,35 @@
+---
+title: Docs
+---
+
+#### Requirements
+The following dependencies are required to build Kestra docs locally:
+- Node 14+ and npm
+- an IDE (Webstorm or VS Code)
+
+To start contributing:
+- [Fork](https://github.com/kestra-io/docs/fork) the repository
+- Clone the fork on your workstation:
+
+```shell
+$ git clone [email protected]:{YOUR_USERNAME}/docs.git
+$ cd docs
+```
+
+
+#### Develop
+Use the following commands to serve the docs locally:
+
+```shell
+# install dependencies
+$ npm install
+
+# serve with hot reload at localhost:3001
+$ npm run dev
+
+# to generate static pages
+$ npm run generate
+
+# making a production build
+$ npm run build
+```

content/docs/13.contributing.md → content/docs/13.contributing/index.md

@@ -14,14 +14,14 @@ You can contribute to Kestra in many ways depending on your skills and interests
 
 ## Build a plugin
 
-The Kestra community loves plugins! Check out our [plugin developer guide](./10.plugin-developer-guide/index.md) for instructions on how to build a plugin for Kestra.
+The Kestra community loves plugins! Check out our [plugin developer guide](../10.plugin-developer-guide/index.md) for instructions on how to build a plugin for Kestra.
 
 
 ## Contribute to code and docs
 
-Check out our [contributing guide](https://github.com/kestra-io/kestra/blob/develop/.github/CONTRIBUTING.md) to help you get started with contributing code and docs to Kestra.
+Check out our [code of conduct](./01.code-of-conduct.md) to help you get started with contributing to the [orchestra](./02.kestra.md) and [docs](./03.docs.md) for Kestra.
 
 
 ## Write a blog post
 
-You can write a tutorial or article about Kestra for our [blog](../blogs). Send an email to [[email protected]](mailto:[email protected]) to share your idea for the post, and we'll take it from there.
+You can write a tutorial or article about Kestra for our [blog](../../blogs). Email [[email protected]](mailto:[email protected]) to share your idea for the post, and we'll take it from there.