-
Notifications
You must be signed in to change notification settings - Fork 13k
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
Fix googleability of docs #12466
Comments
cc #9461 |
To clarify, the particular problem that has plagued us is that it is too easy to end up with outdated documentation when googling for help with problems. |
Assigning 1.0, P-high. |
I imagine this could be partially alleviated with some well-placed meta tags. |
The very first step should be reading Google's Webmaster Guidelines and related documents. Also, here's a good doc Google has prepared on sensible SEO things webmasters can do.
Here's a really nice video on the topic of meta tags and their usefulness by Google's Matt Cutts: https://www.youtube.com/watch?v=RBTBEfd7z_Y |
The DNS issue is #4394. |
@Valloric thank you for those helpful links. |
I've started a task list in the OP. I did some basic searches for Rust datatypes in a private window today and the results looked good to me. I'm not sure if there's a whole lot we need to do. Google is preferring the 'shorthand' doc urls, not the ones with version numbers in them. I intend to run www.rust-lang.org through Google's various webmaster tools to see if it has any suggestions. |
Well, you are using robots.txt to prevent Google from indexing the old API docs. |
@Valloric we are not preventing indexing of the master docs, which are visible in two locations: |
I've added a meta description to the home page, which is only slightly better than the one goog already pulls out of the page. |
If you're showing the same content from two different URL structures, I recommend reading this Google support doc on canonical URLs. |
This text appears in and improves search results. cc rust-lang#12466
This teach rustdoc to add `<meta name="description">` and `<meta name="keywords">` tags to crate docs. Description is important for search engines because they display it as the page description. Keywords are less useful but still generally recommended. This also changes the "stability dashboard" link to just say "stability", because the current link takes up a lot of space. cc #12466
Nominating for removal from 1.0. Not critical. Worst problems are solved. |
@brson Have you made sure you aren't serving the same page content from two different URL structures without canonical annotations? In your case, making sure one of those pages uses Even better, make one of those URLs 301 to the other or better still, have just one URL structure for getting to the content. |
@Valloric No, I have not. |
@brson Consider fixing that before you get tons of people searching for Rust docs. It's always a good idea to have your canonical urls sorted out, for any site. |
Removing from 1.0 milestone but leaving as P-high. No one wants to block the release on just the issue pointed out by @Valloric 's comment here: #12466 (comment) |
Closing in favor of specific linked bugs. |
Increase worker thread stack and name them CC rust-lang#11370
fix [`empty_docs`] trigger in proc-macro fixes: rust-lang#12377 --- changelog: fix [`empty_docs`] trigger in proc-macros
Googling for Rust documentation gives very inconsistent results, often to very old docs. Newbies often are led astray.
Old description:
This is a topic I haven't paid much attention to, but it's important, and I know our googlability has traditionally been very bad. I don't know at all what needs to be done off hand but it's something we should dedicate some effort to.
Nominating.
Tasks:
<link rel="canonical">
to docs (needs rustdoc needs a way to specify HTML metadata for standalone docs #16178)The text was updated successfully, but these errors were encountered: