[Feature][Doc] correct some issues for Readme.md#10424
Conversation
Issue 1: Connector Count Statement May Be InaccurateLocation: - **Diverse Connectors**: Offers support for over 160 connectors, with ongoing expansion.Related Context:
Problem Description:
The "160+" figure lacks basis and may mislead users. Potential Risks:
Impact Scope:
Severity: MAJOR Improvement Suggestions: - **Diverse Connectors**: Offers support for over 60 connectors, including Source, Sink, and Transform connectors, with ongoing expansion.Or use a more conservative statement: - **Diverse Connectors**: Offers support for 60+ connectors, including Source, Sink, and Transform connectors, with ongoing expansion.Rationale: Should be based on actual codebase statistics to avoid exaggeration. If "160" has a special calculation method (e.g., including different versions, different database types), this should be documented. Issue 2: Complete Removal of SeaTunnel Web Project SectionLocation: Original Content: ## Apache SeaTunnel Web Project
SeaTunnel Web is a web project that provides visual management of jobs, scheduling, running and monitoring capabilities. It is developed based on the SeaTunnel Connector API and the SeaTunnel Zeta Engine. It is a web project that can be deployed independently. It is also a sub-project of SeaTunnel.
For more information, please refer to [SeaTunnel Web](https://github.com/apache/seatunnel-web)Related Context:
Problem Description: Potential Risks:
Impact Scope:
Severity: MAJOR Improvement Suggestions: Option 1 - Restore in Key Features: ## Key Features
- **Diverse Connectors**: Offers support for over 60 connectors...
- **Batch-Stream Integration**: ...
- **Visual Job Management**: Supports visual job design, scheduling, and monitoring through [SeaTunnel Web](https://github.com/apache/seatunnel-web), in addition to coding-based development.Option 2 - Keep a brief section: ## SeaTunnel Web
For visual job management, scheduling, and monitoring capabilities, check out [SeaTunnel Web](https://github.com/apache/seatunnel-web), a web-based sub-project that provides an intuitive interface for developing and managing SeaTunnel jobs.Rationale:
Issue 3: User Case Updates UnverifiedLocation: ## Users
Companies and organizations worldwide use SeaTunnel for research, production, and commercial products.
Explore real-world use cases of SeaTunnel, such as JP mogan, S7, JDT, Bytedance, Tencent Cloud. More use cases can be found on the [SeaTunnel Users](https://seatunnel.apache.org/user).Related Context:
Problem Description:
Potential Risks:
Impact Scope:
Severity: MAJOR (if information is unverified) Improvement Suggestions: ## Users
Companies and organizations worldwide use SeaTunnel for research, production, and commercial products.
Explore real-world use cases and success stories on the [SeaTunnel Users](https://seatunnel.apache.org/user) page.Or, if users must be listed: ## Users
Companies and organizations worldwide use SeaTunnel for research, production, and commercial products. Notable users include ByteDance, Tencent Cloud, and more. Explore all user stories at [SeaTunnel Users](https://seatunnel.apache.org/user).Rationale:
Issue 4: Incomplete Sentence (Grammar Issue)Location: Follow the [Local Deployment](https://seatunnel.apache.org/docs/getting-started/locally/deployment) on SeaTunnel website to get
started quickly.
Please refer to the [Cluster Deployment](https://seatunnel.apache.org/docs/engines/zeta/separated-cluster-deployment)Related Context: Problem Description: Potential Risks:
Impact Scope:
Severity: MINOR Improvement Suggestions: Follow the [Local Deployment](https://seatunnel.apache.org/docs/getting-started/locally/deployment) guide to get started quickly.
For cluster deployment, refer to the [Cluster Deployment](https://seatunnel.apache.org/docs/engines/zeta/separated-cluster-deployment) guide.Or: Follow the [Local Deployment](https://seatunnel.apache.org/docs/getting-started/locally/deployment) guide to get started quickly, or the [Cluster Deployment](https://seatunnel.apache.org/docs/engines/zeta/separated-cluster-deployment) guide for production environments.Rationale: Complete sentence structure is clearer, and users can understand the purpose and difference of the two documents. Issue 5: Inconsistency with Other DocumentationLocation: Problem Description:
Potential Risks:
Impact Scope:
Severity: MAJOR Improvement Suggestions:
Rationale: As a top-level project, documentation consistency is very important, and all related documents should be updated simultaneously in the PR. |
No description provided.