Add descriptions to each component page

[jzaefferer]

Currently our component pages just have the demos, so there's no description of the widget. That's pretty bad for search engine previews.

For example, the preview for googling "jquery progressbar" has the progressbar as the first result, but this as the description: "jQuery: The Write Less, Do More, JavaScript Library. ... Default determinate progress bar. view source. 1. 2. 3. 4. 5. 6. 7. 8. 9. 10. 11. 12. 13. 14. 15. 16. 17. 18. 19 ..."

"jquery tooltip" doesn't gives us the tooltip widget as the first result, the description there is just "jQuery: The Write Less, Do More, JavaScript Library." (btw. I've updated my tooltip plugin's page to get rid of the spanish description and added a link to jqueryui.com/tooltip).

As for texts, we can probably use the description we have inside the manifest files for each plugin. That should be a good starting point.

[jzaefferer]

@tjvantoll is this something you could work on when you're done with API docs?

[tjvantoll]

@jzaefferer Absolutely. But I'll need more information on what / where the manifest files are how I can access the descriptions.

[scottgonzalez]

The source for the manifest files is in a set of json files in the jquery-ui repo: https://github.com/jquery/jquery-ui/tree/master/build

This is tricky to automate though, because the pages are committed in the jqueryui.com, e.g., https://github.com/jquery/jqueryui.com/blob/master/page/accordion.html

Perhaps just manually copy the descriptions over for now and we can figure out a good way to sync this later? We don't really have good descriptions as it is. We really need someone to take the time to write good descriptions (also for the API site).

[jzaefferer]

The search result for tooltip is still pretty bad. For some reason the description isn't picked up. Google shows "Default functionality" and other useless stuff instead.

Might be related to jquery/jquery-wp-content#261

[jzaefferer]

Still awful:

The first link below the silly description goes to http://api.jqueryui.com/tooltip/ (okay, but the link next should contain "API"), the other one to http://jqueryui.com/resources/demos/tooltip/custom-style.html (not okay, we shouldn't see direct links to files in the /resources folder)

[paulirish]

Those are called sitelinks. You can demote ones that are stupid: https://support.google.com/webmasters/answer/47334?hl=en

My understanding is you want a sitemap to make sure google at least knows all the possible URLs it could use as a sitelink.

[jzaefferer]

The description displayed in the results is better now, but the additional links still go to /resources.

[jzaefferer]

Demoting sitelinks seems like a bad solution, since that applies only temporarily (90 days), has to be done manually, and has a limit of 100 URLs.

Also the description regressed again, its now using the default demo description, instead of the widget description.