Skip to content

broken links in documentation search results #2776

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

Closed
Dmitry-A opened this issue Feb 27, 2019 · 7 comments
Closed

broken links in documentation search results #2776

Dmitry-A opened this issue Feb 27, 2019 · 7 comments
Labels
documentation Related to documentation of ML.NET

Comments

@Dmitry-A
Copy link
Contributor

Go to
https://review.docs.microsoft.com/en-us/dotnet/api/microsoft.ml?view=ml-dotnet&branch=smoke-test-preview
Type IEstimator in the search box
A few search results appear, first one being:
Microsoft.ML.Core.Data.IEstimator Interface
Linking to https://review.docs.microsoft.com/en-us/dotnet/api/microsoft.ml.core.data.iestimator-1?view=ml-dotnet

This link goes to 404

@TomFinley
Copy link
Contributor

Thank you @Dmitry-A!

That's kind of weird. It's almost as if the search index was constructed over code built before #2529 was checked in (this being about two weeks ago), but the actual documentation pages (including namespace names) were taken from after it was checked in. I wonder if @JRAlexander has any thoughts on this, since he is AFAIK our documentation expert.

It should of course link to this.

Maybe the smoke test infrastructure is incomplete, and just links to the existing docs (which would of course be pre-#2529)? I could easily imagine this being a deliberate design limitation of the smoke-testing, but I'd feel better knowing for sure.

@TomFinley TomFinley added the documentation Related to documentation of ML.NET label Feb 27, 2019
@JRAlexander
Copy link

Index is on prod only, not review. Reference docs created since 0.10.0 launch won’t display when you search in the left hand navbox until the review docs are pushed to live after 0.11.0 launches and then reindexed.

You can access new content directly, it just isn't indexed yet.

@JRAlexander
Copy link

@JRAlexander
Copy link

Looks like it's in the Microsoft.ML namespace.

@TomFinley
Copy link
Contributor

Yes, I see, thank you @JRAlexander. Good to know this is deliberate and working as intended.

(We are in the process of cleaning up our namespaces. Microsoft.ML.Core.Data is hardly an appropriate place for something as central as IEstimator!!)

Should we close @Dmitry-A?

@Dmitry-A
Copy link
Contributor Author

Yes, I see, thank you @JRAlexander. Good to know this is deliberate and working as intended.
(We are in the process of cleaning up our namespaces. Microsoft.ML.Core.Data is hardly an appropriate place for something as central as IEstimator!!)
Should we close @Dmitry-A?

Sure, as long as this won't show up in release, all good.

@Dmitry-A
Copy link
Contributor Author

By design

@ghost ghost locked as resolved and limited conversation to collaborators Mar 24, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
documentation Related to documentation of ML.NET
Projects
None yet
Development

No branches or pull requests

4 participants