Lorenzo Nicora created FLINK-36008:
--------------------------------------

             Summary: Guidance for connector docs contributions
                 Key: FLINK-36008
                 URL: https://issues.apache.org/jira/browse/FLINK-36008
             Project: Flink
          Issue Type: Improvement
          Components: Documentation
            Reporter: Lorenzo Nicora


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)

Reply via email to