Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

API reference docs (JavaDocs) to docs.microsoft.com #71

Closed
cgillum opened this issue Jun 22, 2022 · 1 comment
Closed

API reference docs (JavaDocs) to docs.microsoft.com #71

cgillum opened this issue Jun 22, 2022 · 1 comment
Labels
documentation Improvements or additions to documentation

Comments

@cgillum
Copy link
Member

cgillum commented Jun 22, 2022

We currently have Azure Functions-specific API documentation here: https://docs.microsoft.com/en-us/java/api/com.microsoft.azure.functions?view=azure-java-stable. We should create similar auto-generated documentation for our two maven packages: durabletask.client and durabletask-azure-functions.

I believe there is a standard process for this that also takes care of auto-updating docs as we release new versions of our maven packages.

@cgillum cgillum added the documentation Improvements or additions to documentation label Jun 22, 2022
@cgillum cgillum changed the title API reference docs to docs.microsoft.com API reference docs (JavaDocs) to docs.microsoft.com Jun 22, 2022
@cgillum cgillum added this to the v1.0.0 (STABLE) milestone Sep 2, 2022
@cgillum
Copy link
Member Author

cgillum commented Sep 2, 2022

Note that Jonathan Giles is helping us with this.

Ideally the durabletask-client package's reference documentation would be under a "Microsoft Durable Task Client" section since we want to use this package both for Functions and for non-Functions scenarios (for example, Dapr). The durabletask-azure-functions package, however, should be part of the existing Azure Functions SDK for Java.

@cgillum cgillum closed this as completed Jan 18, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant