cloud: add doc for Data APP GitHub integration #13674

qiancai · 2023-05-25T02:18:49Z

First-time contributors' checklist

I've signed Contributor License Agreement that's required for repo owners to accept my contribution.

What is changed, added or deleted? (Required)

Which TiDB version(s) do your changes apply to? (Required)

Tips for choosing the affected version(s):

By default, CHOOSE MASTER ONLY so your changes will be applied to the next TiDB major or minor releases. If your PR involves a product feature behavior change or a compatibility change, CHOOSE THE AFFECTED RELEASE BRANCH(ES) AND MASTER.

For details, see tips for choosing the affected versions.

What is the related PR or file link(s)?

This PR is translated from:
Other reference link(s):

Do your changes match any of the following descriptions?

Delete files
Change aliases
Need modification after applied to another branch
Might cause conflicts after applied to another branch

ti-chi-bot · 2023-05-25T02:18:51Z

[REVIEW NOTIFICATION]

This pull request has not been approved.

To complete the pull request process, please ask the reviewers in the list to review by filling /cc @reviewer in the comment.
After your PR has acquired the required number of LGTMs, you can assign this pull request to the committer in the list by filling /assign @committer in the comment to help you merge this pull request.

The full list of commands accepted by this bot can be found here.

Reviewer can indicate their review by submitting an approval review.
Reviewer can cancel approval by submitting a request changes review.

tidb-cloud/data-service-manage-github-integration.md

tidb-cloud/data-service-get-started.md

tidb-cloud/data-service-manage-github-integration.md

tidb-cloud/data-service-get-started.md

tidb-cloud/data-service-manage-data-app.md

tidb-cloud/data-service-get-started.md

tidb-cloud/data-service-manage-data-app.md

tidb-cloud/data-service-manage-github-integration.md

heibaijian · 2023-06-01T06:49:58Z

tidb-cloud/data-service-get-started.md

-4. Click **Create Data App**. The [**Data Service**](https://tidbcloud.com/console/data-service) details page is displayed.
+4. (Optional) To automatically deploy metadata and endpoints of the Data App to your preferred GitHub repository and branch, expand **Connect your Data App to GitHub**, and then do the following:
+
+    1. Click **Install on GitHub**, and then follow the on-screen instructions to install **TiDB Cloud Data Services** as an application on your target repository.


TiDB Cloud Data Service 没有s

updated in 6f89b99

tidb-cloud/data-service-get-started.md

heibaijian · 2023-06-01T06:53:32Z

tidb-cloud/data-service-get-started.md

+
+5. Click **Create Data App**. The [**Data Service**](https://tidbcloud.com/console/data-service) details page is displayed.
+
+If you have connected your Data App to GitHub, check your specified directory in GitHub. If the configuration files of the Data App have been committed to this directory by `tidb-cloud-data-services`, it indicates that your Data App is connected to GitHub successfully. For more information, see [Deploy Automatically with GitHub](/tidb-cloud/data-service-manage-github-integration.md).


tidb-cloud-data-service

updated in 6f89b99

heibaijian · 2023-06-01T06:59:11Z

tidb-cloud/data-service-manage-data-app.md

-3. The newly created Data App is added to the top of the list. A default `untitled endpoint` is created for the new Data App.
+1. On the [**Data Service**](https://tidbcloud.com/console/data-service) page of your project, click <MDSvgIcon name="icon-create-data-app" /> **Create DataApp** in the left pane.
+2. Enter a name for the Data App, and select clusters that you want the Data App to access.
+3. (Optional) To automatically deploy metadata and endpoints of the Data App to your preferred GitHub repository and branch, expand **Connect your Data App to GitHub**, and then do the following:


“deploy metadata and endpoints” 感觉直接写 deploy endpoints 即可，不用突出metadata

tidb-cloud/data-service-manage-data-app.md

heibaijian · 2023-06-01T07:38:46Z

tidb-cloud/data-service-manage-github-integration.md

+
+- Option 1: Update configuration files of your Data App on GitHub.
+
+    |File path  | Notes for the updates  |


文件的内容里字段的含义感觉可以说明一下

文件的内容里字段的含义在前面 Step 1. Connect your Data App to GitHub 的最后已经说明过一遍了

heibaijian · 2023-06-01T07:47:04Z

tidb-cloud/data-service-manage-github-integration.md

+    1. Click **Install on GitHub**, and then follow the on-screen instructions to install **TiDB Cloud Data Services** as an application on your target repository.
+    2. Click **Authorize** to authorize access to the application on GitHub.
+    3. Specify the target repository, branch, and directory where you want to save the configuration files of your Data App.
+


开启 automatic deployment 开关
另外，关联不会有任何的部署动作，如果需要同步endpoint到github中，你需要在UI上进行一次部署操作。

这里的信息在下面的 Step 2 和 Step 3 里

heibaijian · 2023-06-01T07:48:33Z

tidb-cloud/data-service-manage-github-integration.md

+        - When it is enabled, you can review the Data App configuration changes you made in the TiDB Cloud console before the deployment. Based on the review, you can either deploy or discard the changes.
+        - When it is disabled, the Data App configuration changes you made in the TiDB Cloud console are deployed directly.
+
+## Step 3. Deploy your Data App configuration changes to GitHub automatically


configuration changes 感觉语义不是很明确，感觉可以是 endpoints changes

endpoints changes 看起来不太全，因为 linked clusters changes 也会同步到 GitHub，要不用 Step 3. Deploy your Data App changes to GitHub automatically

heibaijian · 2023-06-01T07:50:24Z

tidb-cloud/data-service-manage-github-integration.md

+
+If **Automatic Deployment** is enabled, you can make changes to your Data App configurations either on GitHub or in the TiDB Cloud console:
+
+- Option 1: Update configuration files of your Data App on GitHub.


感觉不要叫 configuration files 就叫 files 吧或者 dataapp directory's content

heibaijian · 2023-06-01T07:55:36Z

tidb-cloud/data-service-manage-data-app.md

+    2. Click **Authorize** to authorize access to the application on GitHub.
+    3. Specify the target repository, branch, and directory where you want to save the configuration files of your Data App.
+
+    > **Note:**


Note里面可以提示下用户：如果用户的directory里的内容为复制的其他 dataapp 的内容，这时文件中的dataapp的app_id并不是用户当前创建的dataapp的app id，这会将用户dataapp UI 的endpoint 覆盖到用户配置的directory中。如果用户想要做的是导入github directory 里的endpoint, 请参照导入流程进行。

Oreoxmt

/lgtm

TOC-tidb-cloud.md

Oreoxmt · 2023-06-05T10:40:38Z

/lgtm cancel

Oreoxmt · 2023-06-05T10:41:06Z

/lgtm

hfxsd · 2023-06-05T10:43:25Z

/LGTM

tidb-cloud/tidb-cloud-release-notes.md

Co-authored-by: Aolin <aolinz@outlook.com>

ti-chi-bot · 2023-06-05T11:24:34Z

@heibaijian: adding LGTM is restricted to approvers and reviewers in OWNERS files.

In response to this:

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

Oreoxmt · 2023-06-05T11:48:08Z

/lgtm

lilin90 · 2023-06-05T11:50:50Z

/lgtm

ti-chi-bot · 2023-06-05T11:50:58Z

[LGTM Timeline notifier]

Timeline:

2023-06-05 10:29:50.232549583 +0000 UTC m=+257776.505522364: ☑️ agreed by hfxsd.
2023-06-05 10:37:04.203603141 +0000 UTC m=+258210.476575918: ☑️ agreed by Oreoxmt.
2023-06-05 10:40:41.995385881 +0000 UTC m=+258428.268358657: ✖️🔁 reset by Oreoxmt.
2023-06-05 10:41:10.522313878 +0000 UTC m=+258456.795286662: ☑️ agreed by Oreoxmt.
2023-06-05 10:43:30.292977644 +0000 UTC m=+258596.565950427: ☑️ agreed by hfxsd.
2023-06-05 10:56:23.602719071 +0000 UTC m=+259369.875691855: ✖️🔁 reset by qiancai.
2023-06-05 11:48:12.561434596 +0000 UTC m=+262478.834407379: ☑️ agreed by Oreoxmt.
2023-06-05 11:50:57.110430026 +0000 UTC m=+262643.383402809: ☑️ agreed by lilin90.

qiancai · 2023-06-05T11:57:28Z

/approve

ti-chi-bot · 2023-06-05T11:57:39Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: heibaijian, hfxsd, lilin90, Oreoxmt, qiancai

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

~~OWNERS~~ [Oreoxmt,hfxsd,lilin90,qiancai]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

qiancai added 3 commits May 16, 2023 13:34

add part of draft

5556cf8

Update data-service-manage-github-integration.md

ec4e75c

add the steps of github connection

e20c0af

ti-chi-bot bot added missing-translation-status This PR does not have translation status info. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels May 25, 2023

ti-chi-bot bot removed the missing-translation-status This PR does not have translation status info. label May 25, 2023

qiancai added 4 commits May 25, 2023 13:48

Update data-service-manage-github-integration.md

d10d8cc

add steps about importing configurations of an existing Data App

d78d9f0

update the files

a833c62

update the steps according to the UI

c3103fc

qiancai marked this pull request as draft May 26, 2023 02:50

ti-chi-bot bot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label May 26, 2023

qiancai commented May 30, 2023

View reviewed changes

tidb-cloud/data-service-manage-github-integration.md Outdated Show resolved Hide resolved

tidb-cloud/data-service-get-started.md Outdated Show resolved Hide resolved

qiancai added 3 commits May 30, 2023 16:17

Apply suggestions from code review

d35c621

Update steps based on UI

4de61c0

Update data-service-manage-data-app.md

441da0b

qiancai commented May 30, 2023

View reviewed changes

tidb-cloud/data-service-manage-github-integration.md Outdated Show resolved Hide resolved

qiancai commented May 31, 2023

View reviewed changes

qiancai added 2 commits May 31, 2023 11:34

Apply suggestions from code review

519f528

Update TOC-tidb-cloud.md

92d2655

qiancai marked this pull request as ready for review June 1, 2023 05:59

ti-chi-bot bot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Jun 1, 2023

heibaijian reviewed Jun 1, 2023

View reviewed changes

TiDB Cloud Data Services -> TiDB Cloud Data Service

6f89b99

Oreoxmt reviewed Jun 5, 2023

View reviewed changes

ti-chi-bot bot added lgtm and removed needs-1-more-lgtm Indicates a PR needs 1 more LGTM. labels Jun 5, 2023

Oreoxmt reviewed Jun 5, 2023

View reviewed changes

TOC-tidb-cloud.md Outdated Show resolved Hide resolved

ti-chi-bot bot removed the lgtm label Jun 5, 2023

ti-chi-bot bot added the needs-1-more-lgtm Indicates a PR needs 1 more LGTM. label Jun 5, 2023

ti-chi-bot bot added lgtm and removed needs-1-more-lgtm Indicates a PR needs 1 more LGTM. labels Jun 5, 2023

Oreoxmt reviewed Jun 5, 2023

View reviewed changes

tidb-cloud/tidb-cloud-release-notes.md Outdated Show resolved Hide resolved

Oreoxmt reviewed Jun 5, 2023

View reviewed changes

tidb-cloud/tidb-cloud-release-notes.md Outdated Show resolved Hide resolved

Apply suggestions from code review

685db8f

Co-authored-by: Aolin <aolinz@outlook.com>

ti-chi-bot bot removed the lgtm label Jun 5, 2023

qiancai added 3 commits June 5, 2023 19:01

fix a broken link

f3b8cf6

Update TOC-tidb-cloud.md

40bc6ed

fix broken links

95fec39

heibaijian approved these changes Jun 5, 2023

View reviewed changes

ti-chi-bot bot added the needs-1-more-lgtm Indicates a PR needs 1 more LGTM. label Jun 5, 2023

ti-chi-bot bot added lgtm and removed needs-1-more-lgtm Indicates a PR needs 1 more LGTM. labels Jun 5, 2023

qiancai removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Jun 5, 2023

ti-chi-bot bot merged commit a3bdc06 into pingcap:release-6.5 Jun 5, 2023


		5. Click Create Data App. The [Data Service](https://tidbcloud.com/console/data-service) details page is displayed.

		If you have connected your Data App to GitHub, check your specified directory in GitHub. If the configuration files of the Data App have been committed to this directory by `tidb-cloud-data-services`, it indicates that your Data App is connected to GitHub successfully. For more information, see [Deploy Automatically with GitHub](/tidb-cloud/data-service-manage-github-integration.md).


		- Option 1: Update configuration files of your Data App on GitHub.

		\|File path \| Notes for the updates \|


		If Automatic Deployment is enabled, you can make changes to your Data App configurations either on GitHub or in the TiDB Cloud console:

		- Option 1: Update configuration files of your Data App on GitHub.

cloud: add doc for Data APP GitHub integration #13674

cloud: add doc for Data APP GitHub integration #13674

Uh oh!

Conversation

qiancai commented May 25, 2023

First-time contributors' checklist

What is changed, added or deleted? (Required)

Which TiDB version(s) do your changes apply to? (Required)

What is the related PR or file link(s)?

Do your changes match any of the following descriptions?

Uh oh!

ti-chi-bot bot commented May 25, 2023

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

qiancai Jun 1, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Oreoxmt left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Oreoxmt commented Jun 5, 2023

Uh oh!

Oreoxmt commented Jun 5, 2023

Uh oh!

hfxsd commented Jun 5, 2023

Uh oh!

Uh oh!

Uh oh!

ti-chi-bot bot commented Jun 5, 2023

Uh oh!

Oreoxmt commented Jun 5, 2023

Uh oh!

lilin90 commented Jun 5, 2023

Uh oh!

ti-chi-bot bot commented Jun 5, 2023

[LGTM Timeline notifier]

Uh oh!

qiancai commented Jun 5, 2023

Uh oh!

ti-chi-bot bot commented Jun 5, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

qiancai Jun 1, 2023 •

edited

Loading