[Docs] Flytekit-Java Docs

[brucearctor]

Describe the documentation update Flytekit-java docs don't exist nicely like flytekit and other parts of flyte. The link just goes to the github repo.

It is likely early, but this would be to track what to use to generate docs, and highlight this is an [eventual ... perhaps not the priority, yet] nice-to-have.

[Smartmind12]

@brucearctor Can you assign this issue to me as i would like to work on it...Thanks!

[brucearctor]

@Smartmind12 - this issue isn't narrow enough, and is more of a meta-issue.

There is related work [ in more tractable pieces ] to address.

Ex:

• Generate Java Docs
• Extend Java Docs in code [ for what gets generated ]
• Update webpage to point to Javadocs
• ... etc ...

Suggesting to create issues for each more tractable piece, and then address them one by one. I'm happy to comment on things, if you link to it here and comment/tag me so that I am alerted.

[Smartmind12]

@Smartmind12 - this issue isn't narrow enough, and is more of a meta-issue.

There is related work [ in more tractable pieces ] to address.

Ex:

• Generate Java Docs
• Extend Java Docs in code [ for what gets generated ]
• Update webpage to point to Javadocs
• ... etc ...

Suggesting to create issues for each more tractable piece, and then address them one by one. I'm happy to comment on things, if you link to it here and comment/tag me so that I am alerted.

It would be helpful if you could create a list of all subsections you want in the document??...So considering those i will move forward and implement

[github-actions[bot]]

Hello 👋, This issue has been inactive for over 9 months. To help maintain a clean and focused backlog, we'll be marking this issue as stale and will close the issue if we detect no activity in the next 7 days. Thank you for your contribution and understanding! 🙏

[github-actions[bot]]

Hello 👋, This issue has been inactive for over 9 months and hasn't received any updates since it was marked as stale. We'll be closing this issue for now, but if you believe this issue is still relevant, please feel free to reopen it. Thank you for your contribution and understanding! 🙏

[kumare3]

cc @honnix what is the plan for getting docs for java sdk?

[honnix]

If this is about javadoc, they are already generated and published to Maven central. (The quality is a not top but that we can improve.) However if this is about generating a Maven site which includes browsable javadoc, we don't have one yet and we will need to figure out where to host it. Maybe github pages.

[honnix]

Maybe we can use https://javadoc.io/ to just host javadocs. That seems to be easier. We will need to take a better look at different options, and legal requirements maybe.

[kumare3]

Is this the right link - https://javadoc.io/doc/org.flyte/flytekit-java/latest/index.html. @honnix would love a getting started that works like pyflyte run

[honnix]

Yes that link is correct but I'm not exactly sure it is OK to use that service. I will ask around in my org.

I think there is still a long way to have a pyflyte run equivalent, because jflyte doesn't do any runtime stuff and there is also generally a lack of oauth module in jflyte. I will bring this back to the team.

[kumare3]

I don't think knitting has to be Flyte run, but package and flytectl register is perfectly fine as a jump of point. I think the audiences are different so this should be ok

[honnix]

That is a very reasonable feature to have. cc @andresgomezfrr @pablocasares

[honnix]

~I think it is a matter of documentation then because jflyte already supports writing proto files to a folder. tar is not support but flytectl can handle individual files well.~

Scratch that. Not so simple because interacting with flyteadmin is still needed to write protos, for example retrieving remote task, so we will have to deal with the auth.

[github-actions[bot]]

Hello 👋, this issue has been inactive for over 9 months. To help maintain a clean and focused backlog, we'll be marking this issue as stale and will engage on it to decide if it is still applicable. Thank you for your contribution and understanding! 🙏