[jira] [Commented] (FLINK-15559) Missing {{site.baseurl}} in some docs
[
https://issues.apache.org/jira/browse/FLINK-15559?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=17014277#comment-17014277
]
Jark Wu commented on FLINK-15559:
-
Thanks for the explanation. I got what you mean. I think you can create another
issue to discuss about exposing {{baseurl}} option for {{build_docs.sh}}.
For this issue, you can fix the bad links first.
> Missing {{site.baseurl}} in some docs
> -
>
> Key: FLINK-15559
> URL: https://issues.apache.org/jira/browse/FLINK-15559
> Project: Flink
> Issue Type: Improvement
> Components: Documentation
>Affects Versions: 1.10.0
>Reporter: Benchao Li
>Assignee: Benchao Li
>Priority: Major
>
> For example, in
> * dev/table/functions/systemFunctions.md
> * dev/table/functions/systemFunctions.zh.md
> * dev/table/sourceSinks.md
> * dev/table/sourceSinks.zh.md
> * dev/table/sql/queries.zh.md
>
--
This message was sent by Atlassian Jira
(v8.3.4#803005)
[jira] [Commented] (FLINK-15559) Missing {{site.baseurl}} in some docs
[
https://issues.apache.org/jira/browse/FLINK-15559?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=17014144#comment-17014144
]
Benchao Li commented on FLINK-15559:
The reason is following:
Currently {{build_docs.sh}} does not use {{baseurl}}, for a url like
{{/dev/table/streaming/query_configuration.html}}, local url is
{{localhost:4000/dev/table/streaming/query_configuration.html}} which is a
valid url.
When we has a baseurl, for example {{/projects/flink/flink-docs-master}}, then
{{localhost:4000/dev/table/streaming/query_configuration.html}} is a broken
url. In this case, it needs to be
{{localhost:4000/projects/flink/flink-docs-master/dev/table/streaming/query_configuration.html}}.
You can check
[https://ci.apache.org/projects/flink/flink-docs-master/dev/table/functions/systemFunctions.html#type-conversion-functions]
The "See the supported types here"'s like is broken due to lacking {{baseurl}}
> Missing {{site.baseurl}} in some docs
> -
>
> Key: FLINK-15559
> URL: https://issues.apache.org/jira/browse/FLINK-15559
> Project: Flink
> Issue Type: Improvement
> Components: Documentation
>Affects Versions: 1.10.0
>Reporter: Benchao Li
>Assignee: Benchao Li
>Priority: Major
>
> For example, in
> * dev/table/functions/systemFunctions.md
> * dev/table/functions/systemFunctions.zh.md
> * dev/table/sourceSinks.md
> * dev/table/sourceSinks.zh.md
> * dev/table/sql/queries.zh.md
>
--
This message was sent by Atlassian Jira
(v8.3.4#803005)
[jira] [Commented] (FLINK-15559) Missing {{site.baseurl}} in some docs
[
https://issues.apache.org/jira/browse/FLINK-15559?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=17014123#comment-17014123
]
Jark Wu commented on FLINK-15559:
-
Why the links are broken because of changing base_url ?
AFAIK, if a link is broken, it should always be broken no matter what the
base_url is. That says we don't need a baseurl option.
> Missing {{site.baseurl}} in some docs
> -
>
> Key: FLINK-15559
> URL: https://issues.apache.org/jira/browse/FLINK-15559
> Project: Flink
> Issue Type: Improvement
> Components: Documentation
>Affects Versions: 1.10.0
>Reporter: Benchao Li
>Assignee: Benchao Li
>Priority: Major
>
> For example, in
> * dev/table/functions/systemFunctions.md
> * dev/table/functions/systemFunctions.zh.md
> * dev/table/sourceSinks.md
> * dev/table/sourceSinks.zh.md
> * dev/table/sql/queries.zh.md
>
--
This message was sent by Atlassian Jira
(v8.3.4#803005)
[jira] [Commented] (FLINK-15559) Missing {{site.baseurl}} in some docs
[
https://issues.apache.org/jira/browse/FLINK-15559?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=17014096#comment-17014096
]
Benchao Li commented on FLINK-15559:
I know it's already in nightly tests. What I mean is we can add a {{baseurl}}
to {{build_docs.sh}}, then we can find bad links due to missing {{baseurl}}
earlier. What's your option?
> Missing {{site.baseurl}} in some docs
> -
>
> Key: FLINK-15559
> URL: https://issues.apache.org/jira/browse/FLINK-15559
> Project: Flink
> Issue Type: Improvement
> Components: Documentation
>Affects Versions: 1.10.0
>Reporter: Benchao Li
>Assignee: Benchao Li
>Priority: Major
>
> For example, in
> * dev/table/functions/systemFunctions.md
> * dev/table/functions/systemFunctions.zh.md
> * dev/table/sourceSinks.md
> * dev/table/sourceSinks.zh.md
> * dev/table/sql/queries.zh.md
>
--
This message was sent by Atlassian Jira
(v8.3.4#803005)
[jira] [Commented] (FLINK-15559) Missing {{site.baseurl}} in some docs
[
https://issues.apache.org/jira/browse/FLINK-15559?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=17014093#comment-17014093
]
Jark Wu commented on FLINK-15559:
-
Thanks for the reporting, I assigend this issue to you. Btw, {{check_links.sh}}
is already in nightly tests.
> Missing {{site.baseurl}} in some docs
> -
>
> Key: FLINK-15559
> URL: https://issues.apache.org/jira/browse/FLINK-15559
> Project: Flink
> Issue Type: Improvement
> Components: Documentation
>Affects Versions: 1.10.0
>Reporter: Benchao Li
>Assignee: Benchao Li
>Priority: Major
>
> For example, in
> * dev/table/functions/systemFunctions.md
> * dev/table/functions/systemFunctions.zh.md
> * dev/table/sourceSinks.md
> * dev/table/sourceSinks.zh.md
> * dev/table/sql/queries.zh.md
>
--
This message was sent by Atlassian Jira
(v8.3.4#803005)
[jira] [Commented] (FLINK-15559) Missing {{site.baseurl}} in some docs
[
https://issues.apache.org/jira/browse/FLINK-15559?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=17014080#comment-17014080
]
Benchao Li commented on FLINK-15559:
Do you think it's beneficial that we add an option in {{build_docs.sh}}, which
adds a baseurl?
Then we can check bad links due to missing {{site.baseurl}} easily. A step
further, we can add this to nightly tests.
> Missing {{site.baseurl}} in some docs
> -
>
> Key: FLINK-15559
> URL: https://issues.apache.org/jira/browse/FLINK-15559
> Project: Flink
> Issue Type: Improvement
> Components: Documentation
>Affects Versions: 1.10.0
>Reporter: Benchao Li
>Priority: Major
>
> For example, in
> * dev/table/functions/systemFunctions.md
> * dev/table/functions/systemFunctions.zh.md
> * dev/table/sourceSinks.md
> * dev/table/sourceSinks.zh.md
> * dev/table/sql/queries.zh.md
>
--
This message was sent by Atlassian Jira
(v8.3.4#803005)
[jira] [Commented] (FLINK-15559) Missing {{site.baseurl}} in some docs
[
https://issues.apache.org/jira/browse/FLINK-15559?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=17014078#comment-17014078
]
Benchao Li commented on FLINK-15559:
[~jark] Yes.
I changed baseurl in local Jekyll proxy, and run {{check_links.sh}}, and found
some bad links due to missing {{site.baseurl}}.
> Missing {{site.baseurl}} in some docs
> -
>
> Key: FLINK-15559
> URL: https://issues.apache.org/jira/browse/FLINK-15559
> Project: Flink
> Issue Type: Improvement
> Components: Documentation
>Affects Versions: 1.10.0
>Reporter: Benchao Li
>Priority: Major
>
> For example, in
> * dev/table/functions/systemFunctions.md
> * dev/table/functions/systemFunctions.zh.md
> * dev/table/sourceSinks.md
> * dev/table/sourceSinks.zh.md
> * dev/table/sql/queries.zh.md
>
--
This message was sent by Atlassian Jira
(v8.3.4#803005)
[jira] [Commented] (FLINK-15559) Missing {{site.baseurl}} in some docs
[
https://issues.apache.org/jira/browse/FLINK-15559?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=17014071#comment-17014071
]
Jark Wu commented on FLINK-15559:
-
Hi [~libenchao], do you mean these links are broken because of missing
{{site.baseurl}} ?
> Missing {{site.baseurl}} in some docs
> -
>
> Key: FLINK-15559
> URL: https://issues.apache.org/jira/browse/FLINK-15559
> Project: Flink
> Issue Type: Improvement
> Components: Documentation
>Affects Versions: 1.10.0
>Reporter: Benchao Li
>Priority: Major
>
> For example, in
> * dev/table/functions/systemFunctions.md
> * dev/table/functions/systemFunctions.zh.md
> * dev/table/sourceSinks.md
> * dev/table/sourceSinks.zh.md
> * dev/table/sql/queries.zh.md
>
--
This message was sent by Atlassian Jira
(v8.3.4#803005)
