Skip to content

Commit

Permalink
docs: v0.21 docs freeze (#704)
Browse files Browse the repository at this point in the history
  • Loading branch information
abeizn authored Jan 23, 2024
1 parent 8c18489 commit 757eaa7
Show file tree
Hide file tree
Showing 200 changed files with 51,154 additions and 9 deletions.
6 changes: 3 additions & 3 deletions docs/GettingStarted/HelmSetup.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ To install the chart with release name `devlake`,follow these steps:
```shell
helm repo add devlake https://apache.github.io/incubator-devlake-helm-chart
helm repo update
helm install devlake devlake/devlake --version=0.19.0-beta6 --set lake.encryptionSecret.secret=$ENCRYPTION_SECRET
helm install devlake devlake/devlake --version=0.20.0-beta8 --set lake.encryptionSecret.secret=$ENCRYPTION_SECRET
```

And visit your devlake from the node port (32001 by default).
Expand Down Expand Up @@ -86,14 +86,14 @@ grafana by url `http://YOUR-NODE-IP:30091`
```shell
helm repo update
helm upgrade devlake devlake/devlake --version=0.19.0-beta6 --set lake.encryptionSecret.secret=<ENCRYPTION_SECRET>
helm upgrade devlake devlake/devlake --version=0.20.0-beta8 --set lake.encryptionSecret.secret=<ENCRYPTION_SECRET>
```
**If you're upgrading from DevLake v0.18.x or later versions:**

```shell
helm repo update
helm upgrade devlake devlake/devlake --version=0.19.0-beta6
helm upgrade devlake devlake/devlake --version=0.20.0-beta8
```

### Uninstall
Expand Down
6 changes: 3 additions & 3 deletions versioned_docs/version-v0.19/GettingStarted/HelmSetup.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ To install the chart with release name `devlake`,follow these steps:
```shell
helm repo add devlake https://apache.github.io/incubator-devlake-helm-chart
helm repo update
helm install devlake devlake/devlake --version=0.19.0-beta6 --set lake.encryptionSecret.secret=$ENCRYPTION_SECRET
helm install devlake devlake/devlake --version=0.19.0 --set lake.encryptionSecret.secret=$ENCRYPTION_SECRET
```

And visit your devlake from the node port (32001 by default).
Expand Down Expand Up @@ -86,14 +86,14 @@ grafana by url `http://YOUR-NODE-IP:30091`
```shell
helm repo update
helm upgrade devlake devlake/devlake --version=0.19.0-beta6 --set lake.encryptionSecret.secret=<ENCRYPTION_SECRET>
helm upgrade devlake devlake/devlake --version=0.19.0 --set lake.encryptionSecret.secret=<ENCRYPTION_SECRET>
```
**If you're upgrading from DevLake v0.18.x or later versions:**

```shell
helm repo update
helm upgrade devlake devlake/devlake --version=0.19.0-beta6
helm upgrade devlake devlake/devlake --version=0.19.0
```

### Uninstall
Expand Down
6 changes: 3 additions & 3 deletions versioned_docs/version-v0.20/GettingStarted/HelmSetup.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ To install the chart with release name `devlake`,follow these steps:
```shell
helm repo add devlake https://apache.github.io/incubator-devlake-helm-chart
helm repo update
helm install devlake devlake/devlake --version=0.19.0-beta6 --set lake.encryptionSecret.secret=$ENCRYPTION_SECRET
helm install devlake devlake/devlake --version=0.20.0-beta8 --set lake.encryptionSecret.secret=$ENCRYPTION_SECRET
```

And visit your devlake from the node port (32001 by default).
Expand Down Expand Up @@ -86,14 +86,14 @@ grafana by url `http://YOUR-NODE-IP:30091`
```shell
helm repo update
helm upgrade devlake devlake/devlake --version=0.19.0-beta6 --set lake.encryptionSecret.secret=<ENCRYPTION_SECRET>
helm upgrade devlake devlake/devlake --version=0.20.0-beta8 --set lake.encryptionSecret.secret=<ENCRYPTION_SECRET>
```
**If you're upgrading from DevLake v0.18.x or later versions:**

```shell
helm repo update
helm upgrade devlake devlake/devlake --version=0.19.0-beta6
helm upgrade devlake devlake/devlake --version=0.20.0-beta8
```

### Uninstall
Expand Down
34 changes: 34 additions & 0 deletions versioned_docs/version-v0.21/Configuration/APIKeys.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
---
title: "API Keys"
sidebar_position: 31
description: >
API Keys
---
## What is an 'API Key'
![api-key-list](images/api-key-list.png)

An API key, also known as an API token, is a string used for authentication when making requests to DevLake's open API or webhook. It serves as a form of identification to ensure authorized access.

An API key contains three components:
1. Name: This is the descriptive name assigned to the key for easy identification.
2. Expiration: You have the option to set an expiration period for the API key, such as 7 days, 30 days, 90 days, or choose for it to never expire.
3. Allowed Path: The API URL or endpoint that the API key is permitted to access. It defines the specific resources that the key can interact with.

## How does an API key work?
### Accessing DevLake Open APIs
Check out the [API docs](/docs/Overview/References.md).

### Utilizing API Key in [Incoming Webhooks](webhook.md)
It is typically not necessary to manually create an API key from the 'API keys' page. Instead, you can follow these steps:

1. Navigate to the 'Data Connection' page.
2. Create a new webhook, and an API key will be automatically generated for you.
3. You can copy the provided curl commands, which include the API key, and save them in your local environment for future use.
4. If you happen to forget to save the API key, do not worry. You can view the webhook details and regenerate a new API key if needed. It is important to note that the API keys automatically generated for webhooks will not be displayed on the 'API keys' page.

![api-key-list](images/auto-generated-api-key.png)


## Troubleshooting

If you run into any problems, please check the [Troubleshooting](/Troubleshooting/Installation.md) or [create an issue](https://github.com/apache/incubator-devlake/issues)
Loading

0 comments on commit 757eaa7

Please sign in to comment.