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.

Sign up for GitHub

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

Jump to bottom

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
@fediazgon
Labels
area/docs doc-sprint Issues to work on during the Kubeflow Doc Sprint kind/feature priority/p2
Projects
doc-sprint

Comments

@sarahmaddox
Copy link
Contributor

sarahmaddox commented May 28, 2019 •
edited
Loading

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 sarahmaddox mentioned this issue Jun 20, 2019
Closed
@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

@jlewi jlewi added this to To Do in Needs Triage Nov 26, 2019
@sarahmaddox sarahmaddox added the doc-sprint Issues to work on during the Kubeflow Doc Sprint label Jan 2, 2020
@sarahmaddox sarahmaddox added this to Sprint backlog in doc-sprint Jan 3, 2020
@jtfogarty
Copy link

/area docs
/priority p2

@jtfogarty jtfogarty moved this from To Do to Assigned to Area Owner For Triage in Needs Triage Jan 6, 2020
@fediazgon
Copy link
Contributor

fediazgon commented Feb 11, 2020 •
edited
Loading

Taking this one!
/assign @fediazgon

@fediazgon fediazgon moved this from Sprint backlog to Issues in progress in doc-sprint Feb 11, 2020
@sarahmaddox
Copy link
Contributor Author

Thanks @fediazgon

/assign @fediazgon

@fediazgon fediazgon mentioned this issue Feb 13, 2020
Merged
@fediazgon fediazgon moved this from Issues in progress to PRs in progress in doc-sprint Feb 13, 2020
@sarahmaddox sarahmaddox moved this from PRs in progress to Issues in progress in doc-sprint Feb 14, 2020
doc-sprint automation moved this from Issues in progress to Done Feb 21, 2020
Needs Triage automation moved this from Assigned to Area Owner For Triage to Closed Feb 21, 2020
@kubeflow-bot kubeflow-bot removed this from Closed in Needs Triage Feb 21, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@fediazgon fediazgon

Labels
area/docs doc-sprint Issues to work on during the Kubeflow Doc Sprint kind/feature priority/p2
Projects
No open projects
doc-sprint
  
Done
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Create minimal usage example for the Pipelines API fediazgon/website
5 participants
@IronPan @sarahmaddox @jtfogarty @fediazgon @k8s-ci-robot