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

Fix googleability of docs #12466

Closed
3 of 6 tasks
brson opened this issue Feb 22, 2014 · 18 comments
Closed
3 of 6 tasks

Fix googleability of docs #12466

brson opened this issue Feb 22, 2014 · 18 comments
Labels
P-medium Medium priority

Comments

@brson
Copy link
Contributor

brson commented Feb 22, 2014

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:

@alexcrichton
Copy link
Member

cc #9461

@pnkfelix
Copy link
Member

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.

@pnkfelix
Copy link
Member

Assigning 1.0, P-high.

@emberian
Copy link
Member

I imagine this could be partially alleviated with some well-placed meta tags.

@pnkfelix pnkfelix added this to the 1.0 milestone Feb 27, 2014
@Valloric
Copy link
Contributor

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.

I imagine this could be partially alleviated with some well-placed meta tags.

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

@adrientetar
Copy link
Contributor

The DNS issue is #4394.

@brson brson self-assigned this Aug 1, 2014
@brson
Copy link
Contributor Author

brson commented Aug 1, 2014

@Valloric thank you for those helpful links.

@brson
Copy link
Contributor Author

brson commented Aug 1, 2014

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.

@Valloric
Copy link
Contributor

Valloric commented Aug 2, 2014

Google is preferring the 'shorthand' doc urls, not the ones with version numbers in them.

Well, you are using robots.txt to prevent Google from indexing the old API docs.

brson added a commit to brson/rust that referenced this issue Aug 2, 2014
@brson
Copy link
Contributor Author

brson commented Aug 2, 2014

@Valloric we are not preventing indexing of the master docs, which are visible in two locations: doc.rust-lang.org and doc.rust-lang.org/master.

@brson
Copy link
Contributor Author

brson commented Aug 2, 2014

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.

@Valloric
Copy link
Contributor

Valloric commented Aug 2, 2014

If you're showing the same content from two different URL structures, I recommend reading this Google support doc on canonical URLs.

brson added a commit to brson/rust that referenced this issue Aug 4, 2014
This text appears in and improves search results.

cc rust-lang#12466
brson added a commit to brson/rust that referenced this issue Aug 4, 2014
brson added a commit to brson/rust that referenced this issue Aug 4, 2014
bors added a commit that referenced this issue Aug 6, 2014
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
@brson
Copy link
Contributor Author

brson commented Sep 11, 2014

Nominating for removal from 1.0. Not critical. Worst problems are solved.

@brson brson assigned brson and unassigned brson Sep 11, 2014
@Valloric
Copy link
Contributor

@brson Have you made sure you aren't serving the same page content from two different URL structures without canonical annotations? http://doc.rust-lang.org/master/std/index.html and http://doc.rust-lang.org/std/index.html show the same page for me. As I mentioned previously, I recommend looking at this Google support doc on canonical URLs.

In your case, making sure one of those pages uses <link rel="canonical" href="[canonical page url]" /> would be a good idea.

Even better, make one of those URLs 301 to the other or better still, have just one URL structure for getting to the content.

@brson
Copy link
Contributor Author

brson commented Sep 11, 2014

@Valloric No, I have not.

@Valloric
Copy link
Contributor

@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.

@pnkfelix
Copy link
Member

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)

@brson
Copy link
Contributor Author

brson commented Jul 14, 2016

Closing in favor of specific linked bugs.

@brson brson closed this as completed Jul 14, 2016
bors added a commit to rust-lang-ci/rust that referenced this issue Jul 25, 2022
matthiaskrgr pushed a commit to matthiaskrgr/rust that referenced this issue Mar 21, 2024
fix [`empty_docs`] trigger in proc-macro

fixes: rust-lang#12377

---

changelog: fix [`empty_docs`] trigger in proc-macros
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
P-medium Medium priority
Projects
None yet
Development

No branches or pull requests

7 participants
@alexcrichton @brson @pnkfelix @emberian @Valloric @adrientetar and others