[jira] [Comment Edited] (FLINK-33970) Add necessary checks for connector document
[
https://issues.apache.org/jira/browse/FLINK-33970?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=17803909#comment-17803909
]
Zhongqiang Gong edited comment on FLINK-33970 at 1/8/24 9:38 AM:
-
Hi [~martijnvisser] [~leonard]
Here is the pr for complete the docs check for connectors. Here is the
[PR|https://github.com/apache/flink-connector-shared-utils/pull/33] in
*flink-connector-shared-utils.*
*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*-
* check out flink repo with only docs dir and check other connectors docs
exclude current connector docs
* move connector (which repo related) docs into flink `docs` dir
* execute hugo build command
*Dead links check:*
_Because of hugo build cannot check dead link. It's very useful to add dead
link check for this._
* use npm module *markdown-link-check* to check dead link
Currently，dead link check is used only to connector docs, So about enable dead
link check in flink main repo, I want to add this check to
{color:#FF}docs.yml{color:#172b4d} too.{color}{color}
was (Author: JIRAUSER301076):
Hi [~martijnvisser] [~leonard]
Here is the pr for complete the docs check for connectors. Here is the
[PR|https://github.com/apache/flink-connector-shared-utils/pull/33] in
*flink-connector-shared-utils.*
*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*-
* check out flink repo with only docs dir and check other connectors docs
exclude current connector docs
* move connector (which repo related) docs into flink `docs` dir
* execute hugo build command
*Dead links check:*
_Because of hugo build cannot check dead link. It's very useful to add dead
link check for this._
* 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)
[jira] [Comment Edited] (FLINK-33970) Add necessary checks for connector document
[ https://issues.apache.org/jira/browse/FLINK-33970?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=17803382#comment-17803382 ] Zhongqiang Gong edited comment on FLINK-33970 at 1/7/24 1:16 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*- * check out flink repo with only docs dir and check other connectors docs exclude current connector docs * move connector (which repo related) docs into flink `docs` dir * execute hugo build command *Dead links check:* _Because of hugo build cannot check dead link. It's very useful to add dead link check for this._ * 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 *Dead links check:* _Because of hugo build cannot check dead link. It's very useful to add dead link check for this._ * 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)
[jira] [Comment Edited] (FLINK-33970) Add necessary checks for connector document
[ https://issues.apache.org/jira/browse/FLINK-33970?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=17803450#comment-17803450 ] Zhongqiang Gong edited comment on FLINK-33970 at 1/5/24 8:10 AM: - I had complete dead link check at [https://github.com/GOODBOY008/flink-connector-shared-utils/tree/ci_utils] jdbc connector action for test ci : [https://github.com/GOODBOY008/flink-connector-jdbc/actions/runs/7419405021/job/2012787] was (Author: JIRAUSER301076): I had complete dead link check at [https://github.com/|https://github.com/apache/flink-connector-shared-utils/tree/ci_utils] [GOODBOY008|https://github.com/GOODBOY008/flink-connector-jdbc/actions/runs/7419405021/job/2012787] [/flink-connector-shared-utils/tree/ci_utils|https://github.com/apache/flink-connector-shared-utils/tree/ci_utils] jdbc connector action for test ci : [https://github.com/GOODBOY008/flink-connector-jdbc/actions/runs/7419405021/job/2012787] > 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)
[jira] [Comment Edited] (FLINK-33970) Add necessary checks for connector document
[ https://issues.apache.org/jira/browse/FLINK-33970?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=17803450#comment-17803450 ] Zhongqiang Gong edited comment on FLINK-33970 at 1/5/24 8:07 AM: - I had complete dead link check at [https://github.com/|https://github.com/apache/flink-connector-shared-utils/tree/ci_utils] [GOODBOY008|https://github.com/GOODBOY008/flink-connector-jdbc/actions/runs/7419405021/job/2012787] [/flink-connector-shared-utils/tree/ci_utils|https://github.com/apache/flink-connector-shared-utils/tree/ci_utils] jdbc connector action for test ci : [https://github.com/GOODBOY008/flink-connector-jdbc/actions/runs/7419405021/job/2012787] was (Author: JIRAUSER301076): jdbc action for test : https://github.com/GOODBOY008/flink-connector-jdbc/actions/runs/7419405021/job/2012787 > 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)
[jira] [Comment Edited] (FLINK-33970) Add necessary checks for connector document
[ https://issues.apache.org/jira/browse/FLINK-33970?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=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)
[jira] [Comment Edited] (FLINK-33970) Add necessary checks for connector document
[ https://issues.apache.org/jira/browse/FLINK-33970?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=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 *Dead links check:* _Because of hugo build cannot check dead link. It's very useful to add dead link check for this._ * 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)
[jira] [Comment Edited] (FLINK-33970) Add necessary checks for connector document
[
https://issues.apache.org/jira/browse/FLINK-33970?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=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)
[jira] [Comment Edited] (FLINK-33970) Add necessary checks for connector document
[
https://issues.apache.org/jira/browse/FLINK-33970?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=17803382#comment-17803382
]
Zhongqiang Gong edited comment on FLINK-33970 at 1/5/24 2:47 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:*
* 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)
[jira] [Comment Edited] (FLINK-33970) Add necessary checks for connector document
[ https://issues.apache.org/jira/browse/FLINK-33970?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=17803150#comment-17803150 ] Zhongqiang Gong edited comment on FLINK-33970 at 1/4/24 1:13 PM: - [~tison] I also want to add this check to other connector repo to avoid to build flink doc failed , what do you think about this ? was (Author: JIRAUSER301076): [~tison] I also want to add this check to other connector repo to avoid to build flink doc failed , want do you think about this ? > 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)
