You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@seatunnel.apache.org by "davidzollo (via GitHub)" <gi...@apache.org> on 2026/01/30 15:53:15 UTC

[PR] [Feature][Doc] correct some issues for Readme.md [seatunnel]

davidzollo opened a new pull request, #10424:
URL: https://github.com/apache/seatunnel/pull/10424

   (no comment)


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@seatunnel.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] [Feature][Doc] correct some issues for Readme.md [seatunnel]

Posted by "corgy-w (via GitHub)" <gi...@apache.org>.
corgy-w merged PR #10424:
URL: https://github.com/apache/seatunnel/pull/10424


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@seatunnel.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] [Feature][Doc] correct some issues for Readme.md [seatunnel]

Posted by "DanielCarter-stack (via GitHub)" <gi...@apache.org>.
DanielCarter-stack commented on PR #10424:
URL: https://github.com/apache/seatunnel/pull/10424#issuecomment-3831157005

   <!-- code-pr-reviewer -->
   <!-- cpr:pr_reply_v2_parts {"group": "apache/seatunnel#10424", "part": 1, "total": 1} -->
   ### Issue 1: Connector Count Statement May Be Inaccurate
   
   **Location**: `README.md:22`
   
   ```markdown
   - **Diverse Connectors**: Offers support for over 160 connectors, with ongoing expansion.
   ```
   
   **Related Context**:
   - Actual statistics: approximately 61 connector directories under seatunnel-connectors-v2
   - docs/en/introduction/about.md still describes it as "more than 100 Connectors"
   
   **Problem Description**:
   The PR updates the connector count from "over 100" to "over 160", but based on actual codebase statistics:
   - connector-* directories: 61
   - connector-cdc subdirectories: 7
   - Total: approximately 68 independent connectors
   
   The "160+" figure lacks basis and may mislead users.
   
   **Potential Risks**:
   - Risk 1: Users may believe SeaTunnel supports far more connectors than it actually does
   - Risk 2: Inconsistency with official documentation description
   - Risk 3: Affects project credibility
   
   **Impact Scope**:
   - Direct impact: README.md line 22
   - Indirect impact: User perception of project scale
   - Affected parties: All users visiting the GitHub README
   
   **Severity**: MAJOR
   
   **Improvement Suggestions**:
   ```markdown
   - **Diverse Connectors**: Offers support for over 60 connectors, including Source, Sink, and Transform connectors, with ongoing expansion.
   ```
   
   Or use a more conservative statement:
   ```markdown
   - **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 Section
   
   **Location**: `README.md` (deleted the original "Apache SeaTunnel Web Project" section)
   
   **Original Content**:
   ```markdown
   ## 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**:
   - docs/en/introduction/about.md line 34 still mentions: "Two job development methods are supported: coding and canvas design. The SeaTunnel web project https://github.com/apache/seatunnel-web provides visual management..."
   - Key Features section also deleted the "Two Job Development Methods" feature
   - SeaTunnel Web is an independent Apache subproject (https://github.com/apache/seatunnel-web)
   
   **Problem Description**:
   The PR completely removes the independent section about the SeaTunnel Web project, while also deleting the "Two Job Development Methods" description in Key Features. This will significantly reduce the visibility of the SeaTunnel Web subproject, and new users may not know about the visual job development and management capabilities.
   
   **Potential Risks**:
   - Risk 1: SeaTunnel Web project exposure significantly reduced, affecting user adoption
   - Risk 2: Users may think SeaTunnel only supports coding-based job development, reducing perceived ease of use
   - Risk 3: Inconsistency with official documentation description, causing information confusion
   
   **Impact Scope**:
   - Direct impact: README.md structure
   - Indirect impact: SeaTunnel Web project user discovery and usage
   - Affected parties: All users who learn about SeaTunnel through GitHub
   
   **Severity**: MAJOR
   
   **Improvement Suggestions**:
   Retain mention of the SeaTunnel Web project, at least in "Key Features" or a separate paragraph:
   
   **Option 1 - Restore in Key Features**:
   ```markdown
   ## 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**:
   ```markdown
   ## 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**: 
   1. SeaTunnel Web is an important component of the project, providing visual development capabilities
   2. As a subproject of an Apache top-level project, it should have appropriate exposure in the main project README
   3. Visual development is an important feature of data integration tools and should not be completely hidden
   
   ---
   
   ### Issue 3: User Case Updates Unverified
   
   **Location**: `README.md:54-56`
   
   ```markdown
   ## 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**:
   - Original content: Weibo, Tencent Cloud, Sina, Sogou, and Yonghui Superstores
   - Link changed from "SeaTunnel Blog" to "SeaTunnel Users"
   
   **Problem Description**:
   The PR completely replaces the user list from "Weibo, Tencent Cloud, Sina, Sogou, and Yonghui Superstores" with "JP mogan, S7, JDT, Bytedance, Tencent Cloud". The naming conventions and authenticity of the new user names are questionable:
   - "JP mogan" - irregular capitalization, should it be "JP Morgan"?
   - "S7" - too brief, cannot identify the specific company
   - "JDT" - unclear abbreviation
   - "Bytedance" - if true, this is an important user endorsement
   
   **Potential Risks**:
   - Risk 1: If the user list is inaccurate, it will damage project credibility
   - Risk 2: Irregular naming appears unprofessional
   - Risk 3: May cause objections from listed users
   
   **Impact Scope**:
   - Direct impact: README.md lines 54-56
   - Indirect impact: Project credibility and user perception
   - Affected parties: All users visiting the GitHub README and mentioned companies
   
   **Severity**: MAJOR (if information is unverified)
   
   **Improvement Suggestions**:
   ```markdown
   ## 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:
   ```markdown
   ## 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**: 
   1. Avoid hardcoding potentially changing or unverified user lists in the README
   2. Linking to the official website's user page is more flexible and easier to maintain
   3. If listing is necessary, use standard formal company names and ensure usage permission is obtained
   4. "Tencent Cloud" from the original list was retained, indicating it may be a verified real user
   
   ---
   
   ### Issue 4: Incomplete Sentence (Grammar Issue)
   
   **Location**: `README.md:82-84`
   
   ```markdown
   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**:
   FAQ item 1 "How do I install SeaTunnel?"
   
   **Problem Description**:
   Line 84 is missing a period after the "Cluster Deployment" link, making the sentence incomplete. It should fully explain what Cluster Deployment is, or complete the sentence structure.
   
   **Potential Risks**:
   - Risk 1: Documentation appears unprofessional
   - Risk 2: Users may not understand the purpose of Cluster Deployment
   
   **Impact Scope**:
   - Direct impact: README.md lines 82-84
   - Affected parties: Users reading the FAQ
   
   **Severity**: MINOR
   
   **Improvement Suggestions**:
   ```markdown
   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:
   ```markdown
   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 Documentation
   
   **Location**: `README.md` vs `docs/en/introduction/about.md`
   
   **Problem Description**:
   There is information inconsistency between README.md and docs/en/introduction/about.md:
   
   1. **Connector Count**:
      - README.md: "over 160 connectors"
      - about.md: "more than 100 Connectors"
   
   2. **SeaTunnel Web Description**:
      - README.md: Completely deleted
      - about.md: "Two job development methods are supported: coding and canvas design. The SeaTunnel web project provides visual management..."
   
   **Potential Risks**:
   - Risk 1: Users see inconsistent information in different documents, causing confusion
   - Risk 2: Reduces documentation professionalism and credibility
   
   **Impact Scope**:
   - Direct impact: Documentation consistency
   - Indirect impact: User trust
   
   **Severity**: MAJOR
   
   **Improvement Suggestions**:
   Synchronize updates to docs/en/introduction/about.md:
   
   1. Unify connector count description (recommend using verified numbers)
   2. Also update the SeaTunnel Web description in about.md to ensure consistency
   
   **Rationale**: As a top-level project, documentation consistency is very important, and all related documents should be updated simultaneously in the PR.
   
   ---


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@seatunnel.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org