You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@devlake.apache.org by zk...@apache.org on 2022/07/14 03:43:02 UTC
[incubator-devlake-website] branch main updated: fix: updated version names
This is an automated email from the ASF dual-hosted git repository.
zky 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 969e4777 fix: updated version names
969e4777 is described below
commit 969e47775fddff68d5b204887ddb670311790cd7
Author: yumengwang03 <yu...@merico.dev>
AuthorDate: Thu Jul 14 11:28:47 2022 +0800
fix: updated version names
---
docusaurus.config.js | 12 +-
.../UserManuals/TeamConfiguration.md | 129 ---------------------
2 files changed, 7 insertions(+), 134 deletions(-)
diff --git a/docusaurus.config.js b/docusaurus.config.js
index a0d36c29..3712b75f 100644
--- a/docusaurus.config.js
+++ b/docusaurus.config.js
@@ -28,7 +28,9 @@ const versions = require('./versions.json');
editUrl: 'https://github.com/apache/incubator-devlake-website/edit/main',
versions: {
current: {
+ label:'Latest',
path: '',
+ banner:'none',
},
[versions[0]]: {
path: versions[0],
@@ -91,6 +93,10 @@ const versions = require('./versions.json');
position: 'right',
label: 'Docs',
items: [
+ {
+ label: "Latest",
+ to: "/docs/Overview/Introduction",
+ },
...versions.slice(0, versions.length - 2).map((version) => ({
label: version,
to: `docs/${version}/Overview/Introduction`,
@@ -98,11 +104,7 @@ const versions = require('./versions.json');
...versions.slice(versions.length - 2, versions.length).map((version) => ({
label: (version === "1.x") ? "1.x(Not Apache Release)" : version,
to: `docs/${version}/Overview/Introduction`,
- })),
- {
- label: "Latest",
- to: "/docs/Overview/Introduction",
- }
+ }))
]
},
{
diff --git a/versioned_docs/version-v0.11.0/UserManuals/TeamConfiguration.md b/versioned_docs/version-v0.11.0/UserManuals/TeamConfiguration.md
deleted file mode 100644
index 4646ffa8..00000000
--- a/versioned_docs/version-v0.11.0/UserManuals/TeamConfiguration.md
+++ /dev/null
@@ -1,129 +0,0 @@
----
-title: "Team Configuration"
-sidebar_position: 6
-description: >
- Team Configuration
----
-## 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.**