docs-cn icon indicating copy to clipboard operation
docs-cn copied to clipboard

Published 20 hours ago • verified publisher icon pingcap

dm: ambiguous illustration about WebUI

Open buchuitoudegou opened this issue 2 years ago • 7 comments

Change Request

This repository is ONLY used to solve problems related to DOCS-CN. For other issues (TiDB, TiKV, etc), please move to other repositories.

Please answer the following questions before submitting your issue. Thanks!

  1. Describe what you find is inappropriate or missing in the existing docs.

In the webui doc, it only states that the port to visit WebUI is the same as the one of the OpenAPI. But in fact, we cannot use WebUI unless we turn on the OpenAPI, which should be clearly emphasized in the docs.

related question: https://asktug.com/t/topic/872887

  1. Describe your suggestion or addition.
  1. Provide some reference materials (documents, websites, etc) if you could.

buchuitoudegou avatar Aug 04 '22 09:08 buchuitoudegou

/area dm

buchuitoudegou avatar Aug 04 '22 09:08 buchuitoudegou

the prerequisite was removed from this pr: https://github.com/pingcap/docs-cn/pull/9477

buchuitoudegou avatar Aug 04 '22 09:08 buchuitoudegou

@WizardXiao PTAL. Do you think we should add the prerequisites?

ran-huang avatar Aug 04 '22 10:08 ran-huang

/cc @sunzhaoyang

buchuitoudegou avatar Aug 04 '22 11:08 buchuitoudegou

the openapi feature is turned off by default but webui relies on openapi, so we should add the prerequisites back see https://docs.pingcap.com/zh/tidb/v5.4/dm-open-api cc @ran-huang

Ehco1996 avatar Aug 05 '22 00:08 Ehco1996

@WizardXiao PTAL. Do you think we should add the prerequisites?

agree with @Ehco1996. Open by default will be in other pr.

WizardXiao avatar Aug 05 '22 03:08 WizardXiao

Will do. /assign

ran-huang avatar Aug 05 '22 08:08 ran-huang