[
https://issues.apache.org/jira/browse/FLINK-33970?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17803382#comment-17803382
]
Zhongqiang Gong edited comment on FLINK-33970 at 1/5/24 2:48 AM:
-----------------------------------------------------------------
[~martijnvisser] [~leonard] Can you give me some advices for this issue?
I have a idea for this issue:
*Hugo build check:*
_Because connector docs depends on flink main docs and no dependencies between
connector docs , so we can just check flink main docs and single connector
docs. Finally,We use hugo build to check docs._
* check out flink repo with only `docs` dir cloned ,use *sparse-checkout*
* move connector (which repo related) docs into flink `docs` dir
* execute hugo build command
Because of hugo build cannot check dead link. It's very useful to add dead link
check for this.
*Dead links check:*
* use npm module *markdown-link-check* to check dead link
was (Author: JIRAUSER301076):
[~martijnvisser] [~leonard] Can you give me some advices for this issue?
I have a idea for this issue:
*Hugo build check:*
{_}Because connector docs depends on flink main docs and no dependencies
between connector docs , so we can just check flink main docs and single
connector docs. Finally,We use hugo build to check docs.{_}{*}{*}
* check out flink repo with only `docs` dir cloned ,use *sparse-checkout*
* move connector (which repo related) docs into flink `docs` dir
* execute hugo build command
Because of hugo build cannot check dead link. It's very useful to add dead link
check for this.
*Dead links check:*
* use npm module *markdown-link-check* to check dead link
> Add necessary checks for connector document
> -------------------------------------------
>
> Key: FLINK-33970
> URL: https://issues.apache.org/jira/browse/FLINK-33970
> Project: Flink
> Issue Type: Improvement
> Components: Documentation
> Reporter: Leonard Xu
> Assignee: Zhongqiang Gong
> Priority: Major
> Labels: pull-request-available
> Fix For: pulsar-4.2.0, pulsar-4.1.1
>
>
> In FLINK-33964, we found the documentation files in independent connector
> repos lacks basic checks like broken url, this ticket aims to add necessary
> checks and avoid similar issue.
--
This message was sent by Atlassian Jira
(v8.20.10#820010)
