Re: [PR] [FLINK-34441] Add guide to submit flink SQL scripts via the operator (using flink-sql-runner-example) [flink-kubernetes-operator]

2024-02-14 Thread via GitHub


prakash-42 commented on code in PR #776:
URL: 
https://github.com/apache/flink-kubernetes-operator/pull/776#discussion_r1490538791


##
docs/content/docs/custom-resource/overview.md:
##
@@ -216,6 +216,38 @@ Alternatively, if you use helm to install 
flink-kubernetes-operator, it allows y
 
 - Last-state upgradeMode is currently not supported for FlinkSessionJobs
 
+## Flink SQL Jobs

Review Comment:
   Thanks for the comments @mxm ! I agree that we should have a dedicated page 
for examples, instead of adding more in the overview page. However, I have a 
few follow-up concerns/questions:
   
   1. If I don't copy over from the examples' readme, I'd still be needing to 
write content that's similar to whatever is present in the example's readme. I 
can try and make it short, while linking to the readme page for more details.
   
   2. If I create a dedicated Examples page, then I think it shouldn't just 
have the Flink SQL example, but other examples as well. I will try and write a 
few more, but not sure if I have enough experience/knowledge to write about all 
the examples. Can we make this like a running doc where more examples will be 
added as the need arises?
   
   3. One concern I have about linking to README pages is that I'm likely going 
to link to the examples in main branch, and that code may change with later 
releases in the operator. Would that possibly make the examples in the operator 
point to an incompatible readme? (I see that the existing links also point to 
the main branch, so maybe that's okay)
   



-- 
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-unsubscr...@flink.apache.org

For queries about this service, please contact Infrastructure at:
us...@infra.apache.org



Re: [PR] [FLINK-34441] Add guide to submit flink SQL scripts via the operator (using flink-sql-runner-example) [flink-kubernetes-operator]

2024-02-14 Thread via GitHub


mxm commented on code in PR #776:
URL: 
https://github.com/apache/flink-kubernetes-operator/pull/776#discussion_r1489321926


##
docs/content/docs/custom-resource/overview.md:
##
@@ -216,6 +216,38 @@ Alternatively, if you use helm to install 
flink-kubernetes-operator, it allows y
 
 - Last-state upgradeMode is currently not supported for FlinkSessionJobs
 
+## Flink SQL Jobs

Review Comment:
   I think we should avoid copying anything over from 
https://github.com/apache/flink-kubernetes-operator/tree/main/examples/. 
Instead, we can extract the above linked examples section to a dedicated page 
and add any extra information we find useful.



##
docs/content/docs/custom-resource/overview.md:
##
@@ -216,6 +216,38 @@ Alternatively, if you use helm to install 
flink-kubernetes-operator, it allows y
 
 - Last-state upgradeMode is currently not supported for FlinkSessionJobs
 
+## Flink SQL Jobs

Review Comment:
   Taking another look, this might not be the best place to add this 
information because it's an overview page and the steps are quite detailed. 
There is already a section mentioning the examples: 
https://nightlies.apache.org/flink/flink-kubernetes-operator-docs-main/docs/concepts/overview/#built-in-examples
 How about creating a dedicated Examples page?



-- 
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-unsubscr...@flink.apache.org

For queries about this service, please contact Infrastructure at:
us...@infra.apache.org



Re: [PR] [FLINK-34441] Add guide to submit flink SQL scripts via the operator (using flink-sql-runner-example) [flink-kubernetes-operator]

2024-02-13 Thread via GitHub


prakash-42 commented on PR #776:
URL: 
https://github.com/apache/flink-kubernetes-operator/pull/776#issuecomment-1942031569

   @mxm Here is a PR for the discussion we were having at PR #596 . Please let 
me know if any updates/improvements are needed. Thank you!


-- 
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-unsubscr...@flink.apache.org

For queries about this service, please contact Infrastructure at:
us...@infra.apache.org



[PR] [FLINK-34441] Add guide to submit flink SQL scripts via the operator (using flink-sql-runner-example) [flink-kubernetes-operator]

2024-02-13 Thread via GitHub


prakash-42 opened a new pull request, #776:
URL: https://github.com/apache/flink-kubernetes-operator/pull/776

   
   
   ## What is the purpose of the change
   
   This pull request adds documentation about flink-sql-runner-example in the 
Kubernetes operator documentation page. Majority of the content is copied over 
from the [flink-sql-runner-example's 
readme](https://github.com/apache/flink-kubernetes-operator/tree/release-1.7/examples/flink-sql-runner-example#flink-kubernetes-operator-sql-example).
   
   
   ## Brief change log
   
 - Added guide to submit flink SQL scripts via the kubernetes operator 
(using flink-sql-runner-example)
   
   ## Verifying this change
   
   *This change is a trivial rework / code cleanup without any test coverage.*
   I don't know if we have tests covering the docs project. I ran the project 
locally and made sure that my changes are being rendered properly.
   
   ## Does this pull request potentially affect one of the following parts:
   
 - Dependencies (does it add or upgrade a dependency): no
 - The public API, i.e., is any changes to the `CustomResourceDescriptors`: 
no
 - Core observer or reconciler logic that is regularly executed: no
   
   ## Documentation
   
 - Does this pull request introduce a new feature? no
 - If yes, how is the feature documented? not applicable
   


-- 
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-unsubscr...@flink.apache.org

For queries about this service, please contact Infrastructure at:
us...@infra.apache.org