You are viewing a plain text version of this content. The canonical link for it is here.

Posted to issues@flink.apache.org by "Yuepeng Pan (Jira)" <ji...@apache.org> on 2026/05/05 23:02:00 UTC

[jira] [Updated] (FLINK-36008) Guidance for previewing connector docs contributions

     [ https://issues.apache.org/jira/browse/FLINK-36008?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Yuepeng Pan updated FLINK-36008:
--------------------------------
    Fix Version/s: 2.4.0
                       (was: 2.3.0)

> Guidance for previewing connector docs contributions
> ----------------------------------------------------
>
>                 Key: FLINK-36008
>                 URL: https://issues.apache.org/jira/browse/FLINK-36008
>             Project: Flink
>          Issue Type: Improvement
>          Components: Documentation
>    Affects Versions: 2.1.0
>            Reporter: Lorenzo Nicora
>            Assignee: Lorenzo Nicora
>            Priority: Minor
>              Labels: pull-request-available
>             Fix For: 2.4.0
>
>
> The [Docs README]([https://github.com/apache/flink/tree/master/docs#include-externally-hosted-documentation)] has some guidance about generating docs of connectors. 
> However, this only works for docs already in the official connector repo ({{{}apache/flink-connector-<connector>{}}}). 
> If you are working on a PR to docs of an existing connector or you are contributing to a new connector, how to generate the preview of your WIP docs is not obvious at all.



--
This message was sent by Atlassian Jira
(v8.20.10#820010)