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

Pipelines: Update SDK references to point to the generated docs on Read The Docs #819

Closed
sarahmaddox opened this issue Jun 20, 2019 · 7 comments
Labels
area/docs doc-sprint Issues to work on during the Kubeflow Doc Sprint kind/feature lifecycle/stale priority/p2

Comments

@sarahmaddox
Copy link
Contributor

We now have auto-generated SDK ref docs on Read The Docs:
https://kubeflow-pipelines.readthedocs.io/en/latest/

We should search for all references in the pages on kubeflow.org that point to the GitHub repo for the SDK, and point to the relevant Read The Docs link instead.

@issue-label-bot
Copy link

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

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

@sarahmaddox sarahmaddox added the doc-sprint Issues to work on during the Kubeflow Doc Sprint label Jun 27, 2019
@sarahmaddox
Copy link
Contributor Author

I've marked this one for tackling during the doc sprint. It's a good one for a tech writer to tackle.

@scottilee
Copy link
Contributor

@sarahmaddox it looks this has been taken care of in some pull requests like https://github.com/kubeflow/website/pull/770/files. I did a search of the docs repo and couldn't find any other references of the SDK that pointed to Github. Let me know if I'm mistaken.

@sarahmaddox
Copy link
Contributor Author

sarahmaddox commented Aug 1, 2019

There are still some left. I haven't done an exhaustive search, but this search and this search pick up some occurrences (tho the latter search contains non-relevant hits too). There may be more.

@scottilee
Copy link
Contributor

@sarahmaddox I was trying to help with this but I wasn't quite clear on the mapping. For instance, the first result from https://github.com/kubeflow/website/search?q=%22github.com%2Fkubeflow%2Fpipelines%2F%22&unscoped_q=%22github.com%2Fkubeflow%2Fpipelines%2F%22, is content/docs/pipelines/sdk/reusable-components.md. Would I just replace the link for reusable components with https://kubeflow-pipelines.readthedocs.io/en/latest/source/kfp.components.html ? And what would I replace Cloud ML Engine model training with -- I couldn't find an equivalent link on https://kubeflow-pipelines.readthedocs.io.

@jtfogarty
Copy link

/area docs
/priority p2

@stale
Copy link

stale bot commented Apr 20, 2020

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

@stale stale bot closed this as completed Apr 27, 2020
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 lifecycle/stale priority/p2
Projects
None yet
Development

No branches or pull requests

4 participants