Skip to content

Commit

Permalink
chore: update document to lead the users to get Slack token (instill-…
Browse files Browse the repository at this point in the history
…ai#137)

Because

- Slack token document is unclear for users

This commit

- Add the instruction.
- Note: please check the reference in
[Linear](https://linear.app/instill-ai/issue/INS-4686/improve-slack-document#comment-85d32dd7)
  • Loading branch information
chuang8511 authored May 27, 2024
1 parent bf6eb41 commit 2145f41
Show file tree
Hide file tree
Showing 4 changed files with 7 additions and 7 deletions.
4 changes: 2 additions & 2 deletions pkg/connector/pinecone/v0/README.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,8 @@ The component configuration is defined and maintained [here](https://github.com/

| Field | Field ID | Type | Note |
| :--- | :--- | :--- | :--- |
| API Key (required) | `api_key` | string | Fill your Pinecone AI API key. You can create a api key in [Pinecone Console](https://app.pinecone.io/) |
| Pinecone Base URL (required) | `url` | string | Fill in your Pinecone base URL. It is in the form [https://index_name-project_id.svc.environment.pinecone.io] |
| API Key (required) | `api_key` | string | Fill your Pinecone AI API key. You can create a api key in Pinecone Console |
| Pinecone Base URL (required) | `url` | string | Fill in your Pinecone base URL. It is in the form |

## Supported Tasks

Expand Down
4 changes: 2 additions & 2 deletions pkg/connector/pinecone/v0/config/definition.json
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
"additionalProperties": false,
"properties": {
"api_key": {
"description": "Fill your Pinecone AI API key. You can create a api key in [Pinecone Console](https://app.pinecone.io/)",
"description": "Fill your Pinecone AI API key. You can create a api key in Pinecone Console",
"instillUpstreamTypes": [
"reference"
],
Expand All @@ -28,7 +28,7 @@
"type": "string"
},
"url": {
"description": "Fill in your Pinecone base URL. It is in the form [https://index_name-project_id.svc.environment.pinecone.io]",
"description": "Fill in your Pinecone base URL. It is in the form",
"instillUpstreamTypes": [
"value"
],
Expand Down
2 changes: 1 addition & 1 deletion pkg/connector/slack/v0/README.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ The component configuration is defined and maintained [here](https://github.com/

| Field | Field ID | Type | Note |
| :--- | :--- | :--- | :--- |
| token | `token` | string | Fill your token |
| Token (required) | `token` | string | Fill in your Slack app access token. For more information about how to access to create app tokens, please refer to the Slack API documentation. |

## Supported Tasks

Expand Down
4 changes: 2 additions & 2 deletions pkg/connector/slack/v0/config/definition.json
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
"additionalProperties": false,
"properties": {
"token": {
"description": "Fill your token",
"description": "Fill in your Slack app access token. For more information about how to access to create app tokens, please refer to the Slack API documentation.",
"instillUpstreamTypes": [
"reference"
],
Expand All @@ -24,7 +24,7 @@
],
"instillSecret": true,
"instillUIOrder": 0,
"title": "token",
"title": "Token",
"type": "string"
}
},
Expand Down

0 comments on commit 2145f41

Please sign in to comment.