You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@flink.apache.org by GitBox <gi...@apache.org> on 2022/11/09 13:44:12 UTC
[GitHub] [flink] zentol opened a new pull request, #21271: [FLINK-29957][docs] Rework connector docs integration
zentol opened a new pull request, #21271:
URL: https://github.com/apache/flink/pull/21271
Rework the connector integration to not rely on go modules.
Instead we clone the relevant repos at the right branch/tag and merge the content directories into a pseudo hugo module that we put into the /themes directory.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@flink.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [flink] zentol commented on a diff in pull request #21271: [FLINK-29957][docs] Rework connector docs integration
Posted by GitBox <gi...@apache.org>.
zentol commented on code in PR #21271:
URL: https://github.com/apache/flink/pull/21271#discussion_r1017970462
##########
docs/setup_docs.sh:
##########
@@ -35,9 +35,23 @@ echo "Created temporary file" $goModFileLocation/go.mod
# Make Hugo retrieve modules which are used for externally hosted documentation
currentBranch=$(git rev-parse --abbrev-ref HEAD)
+function integrate_connector_docs {
+ connector=$1
+ ref=$2
+ git clone --single-branch --branch ${ref} https://github.com/apache/flink-connector-${connector}
+ theme_dir="../themes/connectors"
+ mkdir -p "${theme_dir}"
+ rsync -a flink-connector-${connector}/docs/content* "${theme_dir}/"
+}
+
if [[ ! "$currentBranch" =~ ^release- ]] || [[ -z "$currentBranch" ]]; then
- # If the current branch is master or not provided, get the documentation from the main branch
Review Comment:
My plan was to just remove these conditions.
AFAICT we don't need them; each release will have an explicit list of integrated connector docs and versions.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@flink.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [flink] flinkbot commented on pull request #21271: [FLINK-29957][docs] Rework connector docs integration
Posted by GitBox <gi...@apache.org>.
flinkbot commented on PR #21271:
URL: https://github.com/apache/flink/pull/21271#issuecomment-1308794831
<!--
Meta data
{
"version" : 1,
"metaDataEntries" : [ {
"hash" : "6cec5f2e98b1d2159602e6bc804bc93f921f3836",
"status" : "UNKNOWN",
"url" : "TBD",
"triggerID" : "6cec5f2e98b1d2159602e6bc804bc93f921f3836",
"triggerType" : "PUSH"
} ]
}-->
## CI report:
* 6cec5f2e98b1d2159602e6bc804bc93f921f3836 UNKNOWN
<details>
<summary>Bot commands</summary>
The @flinkbot bot supports the following commands:
- `@flinkbot run azure` re-run the last Azure build
</details>
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@flink.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [flink] MartijnVisser commented on a diff in pull request #21271: [FLINK-29957][docs] Rework connector docs integration
Posted by GitBox <gi...@apache.org>.
MartijnVisser commented on code in PR #21271:
URL: https://github.com/apache/flink/pull/21271#discussion_r1018775366
##########
docs/setup_docs.sh:
##########
@@ -35,9 +35,23 @@ echo "Created temporary file" $goModFileLocation/go.mod
# Make Hugo retrieve modules which are used for externally hosted documentation
currentBranch=$(git rev-parse --abbrev-ref HEAD)
+function integrate_connector_docs {
+ connector=$1
+ ref=$2
+ git clone --single-branch --branch ${ref} https://github.com/apache/flink-connector-${connector}
+ theme_dir="../themes/connectors"
+ mkdir -p "${theme_dir}"
+ rsync -a flink-connector-${connector}/docs/content* "${theme_dir}/"
+}
+
if [[ ! "$currentBranch" =~ ^release- ]] || [[ -z "$currentBranch" ]]; then
- # If the current branch is master or not provided, get the documentation from the main branch
Review Comment:
Yes we can. It needs to be implemented correctly for each individual release on the release branch
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@flink.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [flink] MartijnVisser commented on a diff in pull request #21271: [FLINK-29957][docs] Rework connector docs integration
Posted by GitBox <gi...@apache.org>.
MartijnVisser commented on code in PR #21271:
URL: https://github.com/apache/flink/pull/21271#discussion_r1017963557
##########
docs/setup_docs.sh:
##########
@@ -35,9 +35,23 @@ echo "Created temporary file" $goModFileLocation/go.mod
# Make Hugo retrieve modules which are used for externally hosted documentation
currentBranch=$(git rev-parse --abbrev-ref HEAD)
+function integrate_connector_docs {
+ connector=$1
+ ref=$2
+ git clone --single-branch --branch ${ref} https://github.com/apache/flink-connector-${connector}
+ theme_dir="../themes/connectors"
+ mkdir -p "${theme_dir}"
+ rsync -a flink-connector-${connector}/docs/content* "${theme_dir}/"
+}
+
if [[ ! "$currentBranch" =~ ^release- ]] || [[ -z "$currentBranch" ]]; then
- # If the current branch is master or not provided, get the documentation from the main branch
Review Comment:
Should we leave the comments here to clarify why we're doing this?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@flink.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [flink] zentol commented on a diff in pull request #21271: [FLINK-29957][docs] Rework connector docs integration
Posted by GitBox <gi...@apache.org>.
zentol commented on code in PR #21271:
URL: https://github.com/apache/flink/pull/21271#discussion_r1017970462
##########
docs/setup_docs.sh:
##########
@@ -35,9 +35,23 @@ echo "Created temporary file" $goModFileLocation/go.mod
# Make Hugo retrieve modules which are used for externally hosted documentation
currentBranch=$(git rev-parse --abbrev-ref HEAD)
+function integrate_connector_docs {
+ connector=$1
+ ref=$2
+ git clone --single-branch --branch ${ref} https://github.com/apache/flink-connector-${connector}
+ theme_dir="../themes/connectors"
+ mkdir -p "${theme_dir}"
+ rsync -a flink-connector-${connector}/docs/content* "${theme_dir}/"
+}
+
if [[ ! "$currentBranch" =~ ^release- ]] || [[ -z "$currentBranch" ]]; then
- # If the current branch is master or not provided, get the documentation from the main branch
Review Comment:
I'm wondering if we cant just remove the conditions.
AFAICT we don't need them; each release will have an explicit list of integrated connector docs and versions.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@flink.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [flink] zentol merged pull request #21271: [FLINK-29957][docs] Rework connector docs integration
Posted by GitBox <gi...@apache.org>.
zentol merged PR #21271:
URL: https://github.com/apache/flink/pull/21271
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@flink.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org