[incubator-devlake-website] 01/03: doc: added bitbucket doc to v0.14

[zk...@apache.org]

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

commit 53fa743bf61c99ab2124a23da1650901ae7511dc
Author: yumengwang03 <yu...@merico.dev>
AuthorDate: Fri Oct 28 14:38:53 2022 +0800

    doc: added bitbucket doc to v0.14
---
 versioned_docs/version-v0.14/Plugins/bitbucket.md | 77 +++++++++++++++++++++++
 1 file changed, 77 insertions(+)

diff --git a/versioned_docs/version-v0.14/Plugins/bitbucket.md b/versioned_docs/version-v0.14/Plugins/bitbucket.md
new file mode 100644
index 000000000..33a829db6
--- /dev/null
+++ b/versioned_docs/version-v0.14/Plugins/bitbucket.md
@@ -0,0 +1,77 @@
+---
+title: "GitHub"
+description: >
+  GitHub Plugin
+---
+
+
+
+## Summary
+
+This plugin collects various entities from Bitbucket, including pull requests, issues, comments, pipelines, git commits, and etc.
+
+As of v0.14.2, `bitbucket` plugin can only be invoked through DevLake API. Its support in Config-UI is WIP.
+
+
+## Usage via DevLake API
+
+> Note: Please replace the `http://localhost:8080` in the sample requests with your actual DevLake API endpoint. For how to view DevLake API's swagger documentation, please refer to the "Using DevLake API" section of [Developer Setup](../DeveloperManuals/DeveloperSetup.md).
+
+
+1. Create a Bitbucket data connection: `POST /plugins/bitbucket/connections`. Please see a sample request below:
+
+```
+curl --location --request POST 'http://localhost:8080/plugins/bitbucket/connections' \
+--header 'Content-Type: application/json' \
+--data-raw '{
+    "endpoint": "https://api.bitbucket.org/2.0/",
+    "username": "<your username>",
+    "password": "<your app password>",
+    "name": "Bitbucket Cloud"
+}'
+```
+
+2. Create a blueprint to collect data from Bitbucket: `POST /blueprints`. Please see a sample request below:
+
+```
+curl --location --request POST 'http://localhost:8080/blueprints' \
+--header 'Content-Type: application/json' \
+--data-raw '{
+    "enabled": true,
+    "mode": "NORMAL",
+    "name": "My Bitbucket Blueprint",
+    "cronConfig": "<cron string of your choice>",
+    "isManual": false,
+    "plan": [[]],
+    "settings": {
+        "connections": [
+            {
+                "plugin": "bitbucket",
+                "connectionId": 1,
+                "scope": [
+                    {
+                        "entities": [
+                            "CODE",
+                            "TICKET",
+                            "CODEREVIEW",
+                            "CROSS"
+                        ],
+                        "options": {
+                            "owner": "<owner of your repo>",
+                            "repo": "<your repo name>"
+                        }
+                    }
+                ]
+            }
+        ],
+        "version": "1.0.0"
+    }
+}'
+```
+
+3. [Optional] Trigger the blueprint manually: `POST /blueprints/{blueprintId}/trigger`. Run this step if you want to trigger the newly created blueprint right away. See an example request below:
+
+```
+curl --location --request POST 'http://localhost:8080/blueprints/<blueprintId>/trigger' \
+--header 'Content-Type: application/json'
+```