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: [email protected]

For queries about this service, please contact Infrastructure at:
[email protected]

Reply via email to