search

kubeflow / pipelines

Machine Learning Pipelines for Kubeflow
https://www.kubeflow.org/docs/components/pipelines/
Apache License 2.0
3.61k stars 1.63k forks source link

SDK reference doc shows master branch content #4616

Closed Bobgy closed 4 years ago

Bobgy commented 4 years ago

A different problem is, how can we ensure the docs correspond to latest released SDK, instead of master branch? We shouldn't incorrectly let people find unreleased features.

Originally posted by @Bobgy in https://github.com/kubeflow/pipelines/issues/4409#issuecomment-700609878

/assign @ark-kun

Bobgy commented 4 years ago

e.g. https://kubeflow-pipelines.readthedocs.io/en/latest/source/kfp.server_api.html#kfp_server_api.api.pipeline_upload_service_api.PipelineUploadServiceApi.upload_pipeline_version this hasn't been released yet

Bobgy commented 4 years ago

I'd prefer configuring readthedocs to allow choosing each previous released versions, so that users with old sdks can also use it as a reference. Maybe not doing this right now, we can start by releasing docs for 1.0.0 and 1.0.3 at the same time

Bobgy commented 4 years ago

also /assign @numerology @chensun

Ark-kun commented 4 years ago

Maybe not doing this right now, we can start by releasing docs for 1.0.0 and 1.0.3 at the same time

Do we really need separate documentation for both 1.0.0 and 1.0.3? Maybe the release-1.0 branch? The stable docs point to 1.0.3 BTW.

Bobgy commented 4 years ago

Good point! I guess that's not necessary. A version for each release branch sounds reasonable.

The stable docs point to 1.0.3 BTW.

Great! Is it possible changing stable docs as the default for readthedocs?

Ark-kun commented 4 years ago

Great! Is it possible changing stable docs as the default for readthedocs?

Done. BTW, check the version switch in the lower left corner.

Ark-kun commented 4 years ago

Switched the default docs version to "stable" which corresponds to the latest release tag. Currently that's 1.0.3

Bobgy commented 4 years ago

@Ark-kun Thank you! Looks great!

Can you inform me how we can configure this? Can we include it in some README.md in this repo, so others know what to do next time?

Ark-kun commented 4 years ago

e.g. https://kubeflow-pipelines.readthedocs.io/en/latest/source/kfp.server_api.html#kfp_server_api.api.pipeline_upload_service_api.PipelineUploadServiceApi.upload_pipeline_version this hasn't been released yet

Hmm. That method seems to be available even in 1.0.0: https://github.com/kubeflow/pipelines/blob/1.0.0/backend/api/python_http_client/kfp_server_api/api/pipeline_upload_service_api.py#L193

Ark-kun commented 4 years ago

Can you inform me how we can configure this?

You need to log in to the RTFD website using the kubeflow-pipelines account using the credentials from the internal Google key store. Then you can activate arbitrary branches and change which is the default one.