[FLINK-36008] Guidance for previewing connector docs contributions

• Type: Improvement
• Status: Open
• Priority: Minor
• Resolution: Unresolved
• Fix Version/s: 2.0.0
• Component/s: Documentation
• Labels: pull-request-available
• Assignee: Lorenzo Nicora
• Reporter: Lorenzo Nicora
• Created: 08/Aug/24 09:56
• Updated: 13/Aug/24 07:28

Description

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.

Issue Links

• links to: GitHub Pull Request #25181