From 459b543b8fccbb078fbe67254d369e14574c59f8 Mon Sep 17 00:00:00 2001 From: "Louis.z" Date: Wed, 28 Aug 2024 19:04:55 +0800 Subject: [PATCH] docs: polish the team config doc (#781) Co-authored-by: Startrekzky --- docs/Configuration/TeamConfiguration.md | 7 +++++-- .../version-v1.0/Configuration/TeamConfiguration.md | 7 +++++-- 2 files changed, 10 insertions(+), 4 deletions(-) diff --git a/docs/Configuration/TeamConfiguration.md b/docs/Configuration/TeamConfiguration.md index 1ccb0a08944..2dc6fd79b1e 100644 --- a/docs/Configuration/TeamConfiguration.md +++ b/docs/Configuration/TeamConfiguration.md @@ -36,10 +36,13 @@ The overall workflow is: 4. Run a heuristic algorithm to populate `user_accounts` table 5. Manually update `user_accounts` when the algorithm can't catch everything -Note: +:::info 1. Please replace `/path/to/*.csv` with the absolute path of the CSV file you'd like to upload. -2. Please replace `http://127.0.0.1:4000` with your actual Config UI service IP and port number. If you have enabled https, please replace it accordingly. +2. Please replace `http://127.0.0.1:4000` with your actual Config UI service IP and port number. If you have enabled HTTPS, please replace it accordingly. +3. Please create your API key on the `API Keys` page instead of using the automatically generated key from the webhook creation. + +::: ## Step 1 - Create the `teams` table diff --git a/versioned_docs/version-v1.0/Configuration/TeamConfiguration.md b/versioned_docs/version-v1.0/Configuration/TeamConfiguration.md index 1ccb0a08944..2dc6fd79b1e 100644 --- a/versioned_docs/version-v1.0/Configuration/TeamConfiguration.md +++ b/versioned_docs/version-v1.0/Configuration/TeamConfiguration.md @@ -36,10 +36,13 @@ The overall workflow is: 4. Run a heuristic algorithm to populate `user_accounts` table 5. Manually update `user_accounts` when the algorithm can't catch everything -Note: +:::info 1. Please replace `/path/to/*.csv` with the absolute path of the CSV file you'd like to upload. -2. Please replace `http://127.0.0.1:4000` with your actual Config UI service IP and port number. If you have enabled https, please replace it accordingly. +2. Please replace `http://127.0.0.1:4000` with your actual Config UI service IP and port number. If you have enabled HTTPS, please replace it accordingly. +3. Please create your API key on the `API Keys` page instead of using the automatically generated key from the webhook creation. + +::: ## Step 1 - Create the `teams` table