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/06/07 02:25:17 UTC

[PR] [Docs] Add connector FAQ writing guidelines [seatunnel]

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

   ## What this PR does\n- add a small contributor guideline for writing connector FAQ sections\n- clarify that FAQ should stay a navigation layer instead of becoming a second source of truth\n- require contributors to verify option names and behavior against the current connector docs and code\n\n## Why\nThe recent connector FAQ work showed that FAQ sections can easily drift from the existing option tables and detailed docs. This PR makes the expected writing pattern explicit for future connector doc updates.\n\n## Validation\n- ./mvnw spotless:apply\n- npx -y markdown-link-check -c .dlc.json -q docs/en/developer/contribute-plugin.md docs/zh/developer/contribute-plugin.md\n- ./mvnw -B -T 1 clean test -D"license.skipAddThirdParty"=true -pl seatunnel-ci-tools -Dtest=AllFileSpecificationCheckTest -DfailIfNoTests=false --no-snapshot-updates\n\n## Scope\n- docs/en/developer/contribute-plugin.md\n- docs/zh/developer/contribute-plugin.md


-- 
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] [Docs] Add connector FAQ writing guidelines [seatunnel]

Posted by "davidzollo (via GitHub)" <gi...@apache.org>.
davidzollo closed pull request #11017: [Docs] Add connector FAQ writing guidelines
URL: https://github.com/apache/seatunnel/pull/11017


-- 
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] [Docs] Add connector FAQ writing guidelines [seatunnel]

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

   Superseded by #11018, which carries the same docs guideline change on a clean base branch with the intended 2-file scope only.


-- 
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