This is an automated email from the ASF dual-hosted git repository. abeizn pushed a commit to branch main in repository https://gitbox.apache.org/repos/asf/incubator-devlake-website.git
commit 11f1626832b0a4eafda98ba8a3e9a18bb73739c6 Author: abeizn <[email protected]> AuthorDate: Thu Jul 14 18:45:34 2022 +0800 fix: team configuration collect accounts --- docs/UserManuals/team-feature-user-guide.md | 129 ---------------------------- static/img/teamflow1.png | Bin 63046 -> 0 bytes static/img/teamflow2.png | Bin 54175 -> 0 bytes static/img/teamflow3.png | Bin 48454 -> 0 bytes static/img/teamflow4.png | Bin 49179 -> 0 bytes static/img/teamflow5.png | Bin 71412 -> 0 bytes static/img/teamflow6.png | Bin 33900 -> 0 bytes static/img/teamflow7.png | Bin 94123 -> 0 bytes 8 files changed, 129 deletions(-) diff --git a/docs/UserManuals/team-feature-user-guide.md b/docs/UserManuals/team-feature-user-guide.md deleted file mode 100644 index 07a080bd..00000000 --- a/docs/UserManuals/team-feature-user-guide.md +++ /dev/null @@ -1,129 +0,0 @@ ---- -title: "Team Feature User Guide" -sidebar_position: 6 -description: > - Team Feature User Guide ---- -## Summary -This is a brief step-by-step guide to using the team feature. - -Notes: -1. Please convert /xxxpath/*.csv to the absolute path of the csv file you want to upload. -2. Please replace the 127.0.0.1:8080 in the text with the actual ip and port. - -## Step 1 - Construct the teams table. -a. Api request example, you can generate sample data. - - i. GET request: http://127.0.0.1:8080/plugins/org/teams.csv?fake_data=true (put into the browser can download the corresponding csv file) - - ii. The corresponding curl command: - curl --location --request GET 'http://127.0.0.1:8080/plugins/org/teams.csv?fake_data=true' - - -b. The actual api request. - - i. Create the corresponding teams file: teams.csv - (Notes: 1.The table table field names should have initial capital letters. 2.Be careful not to change the file suffix when opening csv files through the tool ). - - ii. The corresponding curl command（Quick copy folder path for macOS, Shortcut option + command + c）: - curl --location --request PUT 'http://127.0.0.1:8080/plugins/org/teams.csv' --form 'file=@"/xxxpath/teams.csv"' - - iii. After successful execution, the teams table is generated and the data can be seen in the database table teams. - (Notes: how to connect to the database: mainly through host, port, username, password, and then through sql tools, such as sequal ace, datagrip and other data, of course you can also access through the command line mysql -h `ip` -u `username` -p -P `port`) - - - - -## Step 2 - Construct user tables (roster) -a. Api request example, you can generate sample data. - - i. Get request: http://127.0.0.1:8080/plugins/org/users.csv?fake_data=true (put into the browser can download the corresponding csv file). - - ii. The corresponding curl command: - curl --location --request GET 'http://127.0.0.1:8080/plugins/org/users.csv?fake_data=true' - - -b. The actual api request. - - i. Create the csv file (roster) (Notes: the table header is in capital letters: Id,Email,Name). - - ii. The corresponding curl command: - curl --location --request PUT 'http://127.0.0.1:8080/plugins/org/users.csv' --form 'file=@"/xxxpath/users.csv"' - - iii. After successful execution, the users table is generated and the data can be seen in the database table users. - - - - iv. Generated the team_users table, you can see the data in the team_users table. - - - -## Step 3 - Update users if you need -If there is a problem with team_users association or data in users, just re-put users api interface, i.e. (b in step 2 above) - -## Step 4 - Collect accounts -accounts table is collected by users through devlake. You can see the accounts table information in the database. - - - -## Step 5 - Automatically match existing accounts and users through api requests - -a. Api request: the name of the plugin is "org", connctionId is order to keep same with other plugins. - -``` -curl --location --request POST '127.0.0.1:8080/pipelines' \ ---header 'Content-Type: application/json' \ ---data-raw '{ - "name": "test", - "plan":[ - [ - { - "plugin": "org", - "subtasks":["connectUserAccountsExact"], - "options":{ - "connectionId":1 - } - } - ] - ] -}' -``` - -b. After successful execution, the user_accounts table is generated, and you can see the data in table user_accounts. - - - -## Step 6 - Get user_accountsr relationship -After generating the user_accounts relationship, the user can get the associated data through the GET method to confirm whether the data user and account match correctly and whether the matched accounts are complete. - -a. http://127.0.0.1:8080/plugins/org/user_account_mapping.csv (put into the browser to download the file directly) - -b. The corresponding curl command: -``` -curl --location --request GET 'http://127.0.0.1:8080/plugins/org/user_account_mapping.csv' -``` - - - -c. You can also use sql statements to determine, here to provide a sql statement for reference only. -``` -SELECT a.id as account_id, a.email, a.user_name as account_user_name, u.id as user_id, u.name as real_name -FROM accounts a - join user_accounts ua on a.id = ua.account_id - join users u on ua.user_id = u.id -``` - -## Step 7 - Update user_accounts if you need -If the association between user and account is not as expected, you can change the user_account_mapping.csv file. For example, I change the UserId in the line Id=github:GithubAccount:1:1234 in the user_account_mapping.csv file to 2, and then upload the user_account_mapping.csv file through the api interface. - -a. The corresponding curl command: -``` -curl --location --request PUT 'http://127.0.0.1:8080/plugins/org/user_account_mapping.csv' --form 'file=@"/xxxpath/user_account_mapping.csv"' -``` - -b. You can see that the data in the user_accounts table has been updated. - - - - -**The above is the flow of user usage for the whole team feature.** diff --git a/static/img/teamflow1.png b/static/img/teamflow1.png deleted file mode 100644 index cd6880b6..00000000 Binary files a/static/img/teamflow1.png and /dev/null differ diff --git a/static/img/teamflow2.png b/static/img/teamflow2.png deleted file mode 100644 index 12f66c7c..00000000 Binary files a/static/img/teamflow2.png and /dev/null differ diff --git a/static/img/teamflow3.png b/static/img/teamflow3.png deleted file mode 100644 index e591f282..00000000 Binary files a/static/img/teamflow3.png and /dev/null differ diff --git a/static/img/teamflow4.png b/static/img/teamflow4.png deleted file mode 100644 index 0fb88ad7..00000000 Binary files a/static/img/teamflow4.png and /dev/null differ diff --git a/static/img/teamflow5.png b/static/img/teamflow5.png deleted file mode 100644 index 7c02242f..00000000 Binary files a/static/img/teamflow5.png and /dev/null differ diff --git a/static/img/teamflow6.png b/static/img/teamflow6.png deleted file mode 100644 index 5a55e468..00000000 Binary files a/static/img/teamflow6.png and /dev/null differ diff --git a/static/img/teamflow7.png b/static/img/teamflow7.png deleted file mode 100644 index b24d93db..00000000 Binary files a/static/img/teamflow7.png and /dev/null differ
