Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: contrib: set up dev environment #1888

Merged
merged 5 commits into from
Aug 18, 2023
Merged

docs: contrib: set up dev environment #1888

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
86827a0
docs: contribute: set up dev environment
StackScribe Aug 15, 2023
b1a79ca
markdownlint-fix
StackScribe Aug 15, 2023
9308b61
xref
StackScribe Aug 15, 2023
e7cac03
xref
StackScribe Aug 15, 2023
b1b9982
xref
StackScribe Aug 16, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 4 additions & 11 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,17 +42,10 @@ on Slack and a mentor will surely guide you!

### Prerequisites

* [**Docker**](https://docs.docker.com/get-docker/): a tool for containerization,
which allows software applications to run in isolated environments
and makes it easier to deploy and manage them.
* A Kubernetes `cluster >= Kubernetes 1.24` .If you don’t have one,
we recommend Kubernetes-in-Docker(kind) to set up your local development environment.
* [**kubectl**](https://kubernetes.io/docs/tasks/tools/): a command-line interface tool used for deploying
and managing applications on Kubernetes clusters.
* [**kustomize**](https://kustomize.io/): a tool used for customizing Kubernetes resource configurations
and generating manifests.
* [**Helm**](https://helm.sh/): a package manager for Kubernetes that
simplifies the deployment and management of applications on a Kubernetes cluster.
See
[Set up the development environment](docs/content/en/contribute/software/dev-environ/_index.md)
for information about how to set up an environment
in which you can develop and test software for Keptn.

## Related Technologies

Expand Down
26 changes: 26 additions & 0 deletions docs/content/en/contribute/software/dev-environ/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
---
title: Set up the development environment
description: How to set up an environment to develop and test Keptn software
weight: 30
---

To test and develop software for the Keptn project,
you need to install the following on your system:

* [**Docker**](https://docs.docker.com/get-docker/): a tool for containerization,
which allows software applications to run in isolated environments
and makes it easier to deploy and manage them.
* A Kubernetes cluster running an appropriate version of Kubernetes.
See [Supported Kubernetes versions](../../../docs/install/reqs.md/#supported-kubernetes-versions)
for details.
If you need to set up a local Kubernetes cluster
we recommend Kubernetes-in-Docker(kind).
* [**kubectl**](https://kubernetes.io/docs/tasks/tools/):
a command-line interface tool used for deploying
and managing applications on Kubernetes clusters.
* [**kustomize**](https://kustomize.io/): a tool used
for customizing Kubernetes resource configurations
and generating manifests.
* [**Helm**](https://helm.sh/): a package manager for Kubernetes
that simplifies the deployment and management of applications
on a Kubernetes cluster.