website icon indicating copy to clipboard operation
website copied to clipboard

Your links to your documentation is broken

Open mysterious-progression opened this issue 1 year ago • 8 comments

SDK v1 documentation cannot be found https://kubeflow-pipelines.readthedocs.io/en/1.8.22/source/dsl.html

mysterious-progression avatar Sep 15 '23 17:09 mysterious-progression

Hi @mysterious-progression, thanks for creating this issue. To help define this problem, I'll need to ask you some questions.

  • Where does the URL above come from?
  • Is the content you are looking for the same as https://kubeflow-pipelines.readthedocs.io/en/1.8.22/source/kfp.dsl.html ?

rolfedh avatar Sep 25 '23 20:09 rolfedh

Just zooming by but I replicated the above issue.
Links to the 1.8* version of the docs appear to return 404 at the following links when clicking the drop down for different doc versions: https://kubeflow-pipelines.readthedocs.io/en/stable/source/dsl.html https://kubeflow-pipelines.readthedocs.io/en/stable/source/compiler.html https://kubeflow-pipelines.readthedocs.io/en/stable/source/components.html https://kubeflow-pipelines.readthedocs.io/en/stable/source/client.html https://kubeflow-pipelines.readthedocs.io/en/stable/source/registry.html

I don't know how your sphinx documentation works, but those are at least the links I found that were impacted. I am guessing this is intentional since the documentation structure probably changed with the move from 1.8* to 2*

WillFox avatar Oct 05 '23 20:10 WillFox

Thanks for your comment, @WillFox. I've tried reproducing the issue based on your comment and the others, but I'm not understanding something. Where are these "Links to the 1.8* version of the docs"?

rolfedh avatar Oct 10 '23 18:10 rolfedh

Screenshot 2023-10-10 at 1 27 30 PM

mysterious-progression avatar Oct 10 '23 18:10 mysterious-progression

In 1.8.x, the URL previxed the filename with kpf. In 2.0.x and later, the filenames omit kpf. In other words: https://kubeflow-pipelines.readthedocs.io/en/1.8.20/source/kfp.compiler.html in 1.8 became https://kubeflow-pipelines.readthedocs.io/en/stable/source/compiler.html in 2.0

rolfedh avatar Oct 10 '23 18:10 rolfedh

In https://github.com/kubeflow/website/pull/3602, I have hopefully fixed the issue by adding a series of redirects to the netlify content/en/_redirects file. Because netlify doesn't allow wildcards in the path, I created variations of the redirects for each version of the 1.8.x software. If anyone has a more elegant solution, such as fixing the links in the version-selector widget, that would be preferable.

rolfedh avatar Oct 11 '23 11:10 rolfedh

The issue is with a different website. Not the one that comes from kubeflow/website.

rolfedh avatar Oct 23 '23 12:10 rolfedh

Thanks for your help on this @Arhell. I'm stepping back from trying to fix this issue. I believe the website administrator for the reference content might be in the best position to fix this issue.

rolfedh avatar Nov 10 '23 14:11 rolfedh