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

Create a minimal usage example for the Kubeflow Pipelines API #734

Closed
sarahmaddox opened this issue May 28, 2019 · 7 comments · Fixed by #1688
Closed

Create a minimal usage example for the Kubeflow Pipelines API #734

sarahmaddox opened this issue May 28, 2019 · 7 comments · Fixed by #1688
Assignees
Labels
area/docs doc-sprint Issues to work on during the Kubeflow Doc Sprint kind/feature priority/p2

Comments

@sarahmaddox
Copy link
Contributor

sarahmaddox commented May 28, 2019

For documenting the Kubeflow Pipelines API, we need a minimal example using the API. Suggestion: A bash script that uses curl to call the API with some parameters, highlighting the primary use case for the API.

We'll use the example in a doc that introduces the API and links to the generated API reference.

@issue-label-bot
Copy link

Issue-Label Bot is automatically applying the label improvement/enhancement to this issue, with a confidence of 0.98. Please mark this comment with 👍 or 👎 to give our bot feedback!

Links: app homepage, dashboard and code for this bot.

@sarahmaddox
Copy link
Contributor Author

/assign @IronPan

@sarahmaddox
Copy link
Contributor Author

Suggestion from #708:
"Even if it's just how to generate swagger and create a client from that"

@sarahmaddox
Copy link
Contributor Author

FYI @OfficePop

@sarahmaddox sarahmaddox added the doc-sprint Issues to work on during the Kubeflow Doc Sprint label Jan 2, 2020
@jtfogarty
Copy link

/area docs
/priority p2

@fediazgon
Copy link
Contributor

fediazgon commented Feb 11, 2020

Taking this one!
/assign @fediazgon

@sarahmaddox
Copy link
Contributor Author

Thanks @fediazgon

/assign @fediazgon

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/docs doc-sprint Issues to work on during the Kubeflow Doc Sprint kind/feature priority/p2
Projects
None yet
Development

Successfully merging a pull request may close this issue.

5 participants