You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@devlake.apache.org by yu...@apache.org on 2023/03/01 15:40:10 UTC
[incubator-devlake-website] branch main updated: docs: add csv encoding notice (#451)
This is an automated email from the ASF dual-hosted git repository.
yumeng pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/incubator-devlake-website.git
The following commit(s) were added to refs/heads/main by this push:
new e64919ef38 docs: add csv encoding notice (#451)
e64919ef38 is described below
commit e64919ef3888fe16042c27ad1514c1dffc60c32b
Author: Louis.z <lo...@gmail.com>
AuthorDate: Wed Mar 1 23:40:03 2023 +0800
docs: add csv encoding notice (#451)
Co-authored-by: Startrekzky <ka...@merico.dev>
---
docs/Configuration/TeamConfiguration.md | 9 +++++----
.../version-v0.15/UserManuals/TeamConfiguration.md | 14 +++++++-------
2 files changed, 12 insertions(+), 11 deletions(-)
diff --git a/docs/Configuration/TeamConfiguration.md b/docs/Configuration/TeamConfiguration.md
index 0df678875d..e81392acf0 100644
--- a/docs/Configuration/TeamConfiguration.md
+++ b/docs/Configuration/TeamConfiguration.md
@@ -53,7 +53,7 @@ a. Download the template `teams.csv` file
curl --location --request GET 'http://127.0.0.1:4000/api/plugins/org/teams.csv?fake_data=true'
-b. Fill out `teams.csv` file and upload it to DevLake
+b. Fill out `teams.csv` file and upload it to DevLake (If you are using Excel to modify the CSV file, please save it with UTF-8 encoding. See [how](https://answers.microsoft.com/en-us/msoffice/forum/all/how-can-i-save-a-csv-with-utf-8-encoding-using/12801501-c1e4-4a64-80d9-96b680b64cfe))
i. Fill out `teams.csv` with your org data. Please don't modify the column headers or the file suffix.
@@ -79,7 +79,7 @@ a. Download the template `users.csv` file
curl --location --request GET 'http://127.0.0.1:4000/api/plugins/org/users.csv?fake_data=true'
-b. Fill out `users.csv` and upload to DevLake
+b. Fill out `users.csv` and upload to DevLake (If you are using Excel to modify the CSV file, please save it with UTF-8 encoding. See [how](https://answers.microsoft.com/en-us/msoffice/forum/all/how-can-i-save-a-csv-with-utf-8-encoding-using/12801501-c1e4-4a64-80d9-96b680b64cfe))
i. Fill out `users.csv` with your org data. Please don't modify the column headers or the file suffix
@@ -157,13 +157,14 @@ curl --location --request GET 'http://127.0.0.1:4000/api/plugins/org/user_accoun
b. If you find the mapping inaccurate or incomplete, you can modify the `user_account_mapping.csv` file and then upload it to DevLake.
For example, here we change the `UserId` of row 'Id=github:GithubAccount:1:1234' in the `user_account_mapping.csv` file to 2.
-Then we upload the updated `user_account_mapping.csv` file with the following curl command:
+
+c. Save and upload the updated `user_account_mapping.csv` file with the following curl command (If you are using Excel to modify the CSV file, please save it with UTF-8 encoding. See [how](https://answers.microsoft.com/en-us/msoffice/forum/all/how-can-i-save-a-csv-with-utf-8-encoding-using/12801501-c1e4-4a64-80d9-96b680b64cfe)):
```
curl --location --request PUT 'http://127.0.0.1:4000/api/plugins/org/user_account_mapping.csv' --form 'file=@"/path/to/user_account_mapping.csv"'
```
-c. You can verify the data in the `user_accounts` table has been updated.
+d. You can verify the data in the `user_accounts` table has been updated.
diff --git a/versioned_docs/version-v0.15/UserManuals/TeamConfiguration.md b/versioned_docs/version-v0.15/UserManuals/TeamConfiguration.md
index 8457fd76a0..abeb370acd 100644
--- a/versioned_docs/version-v0.15/UserManuals/TeamConfiguration.md
+++ b/versioned_docs/version-v0.15/UserManuals/TeamConfiguration.md
@@ -53,10 +53,9 @@ a. Download the template `teams.csv` file
curl --location --request GET 'http://127.0.0.1:4000/api/plugins/org/teams.csv?fake_data=true'
-b. Fill out `teams.csv` file and upload it to DevLake
+b. Fill out `teams.csv` file and upload it to DevLake (If you are using Excel to modify the CSV file, please save it with UTF-8 encoding. See [how](https://answers.microsoft.com/en-us/msoffice/forum/all/how-can-i-save-a-csv-with-utf-8-encoding-using/12801501-c1e4-4a64-80d9-96b680b64cfe))
i. Fill out `teams.csv` with your org data. Please don't modify the column headers or the file suffix.
-
ii. Upload `teams.csv` to DevLake with the following curl command:
curl --location --request PUT 'http://127.0.0.1:4000/api/plugins/org/teams.csv' --form 'file=@"/path/to/teams.csv"'
@@ -79,9 +78,9 @@ a. Download the template `users.csv` file
curl --location --request GET 'http://127.0.0.1:4000/api/plugins/org/users.csv?fake_data=true'
-b. Fill out `users.csv` and upload to DevLake
+b. Fill out `users.csv` and upload to DevLake (If you are using Excel to modify the CSV file, please save it with UTF-8 encoding. See [how](https://answers.microsoft.com/en-us/msoffice/forum/all/how-can-i-save-a-csv-with-utf-8-encoding-using/12801501-c1e4-4a64-80d9-96b680b64cfe))
- i. Fill out `users.csv` with your org data. Please don't modify the column headers or the file suffix
+ i. Fill out `users.csv` with your org data. Please don't modify the column headers or the file suffix.
ii. Upload `users.csv` to DevLake with the following curl command:
curl --location --request PUT 'http://127.0.0.1:4000/api/plugins/org/users.csv' --form 'file=@"/path/to/users.csv"'
@@ -156,14 +155,15 @@ curl --location --request GET 'http://127.0.0.1:4000/api/plugins/org/user_accoun
b. If you find the mapping inaccurate or incomplete, you can modify the `user_account_mapping.csv` file and then upload it to DevLake.
-For example, here we change the `UserId` of row 'Id=github:GithubAccount:1:1234' in the `user_account_mapping.csv` file to 2.
-Then we upload the updated `user_account_mapping.csv` file with the following curl command:
+For example, here we change the `UserId` of row 'Id=github:GithubAccount:1:1234' in the `user_account_mapping.csv` file to 2.
+
+c. Save and upload the updated `user_account_mapping.csv` file with the following curl command (If you are using Excel to modify the CSV file, please save it with UTF-8 encoding. See [how](https://answers.microsoft.com/en-us/msoffice/forum/all/how-can-i-save-a-csv-with-utf-8-encoding-using/12801501-c1e4-4a64-80d9-96b680b64cfe)):
```
curl --location --request PUT 'http://127.0.0.1:4000/api/plugins/org/user_account_mapping.csv' --form 'file=@"/path/to/user_account_mapping.csv"'
```
-c. You can verify the data in the `user_accounts` table has been updated.
+d. You can verify the data in the `user_accounts` table has been updated.
