OpenRefine / OpenRefine/OpenRefine

Host our own copy of Freebase Suggest documentation

Open
#3,111 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Type: Documentation Type: Feature Request
Dominant language
Java
Stars
12k
Forks
2.2k
Avg merge
1d 14h
Merged PRs (30d)
27

Description

OpenRefine relies on a modified version of the Freebase Suggest widget for looking up reconciliation candidate entities. The code includes no documentation, relying instead on an external web page for documentation, but that's at risk of going away since Google deprecated the code many years ago.

We should either include documentation inline of the options, css, and events or host the documentation in a separate file or on our wiki.

https://developers.google.com/freebase/v1/search-widget#configuration-options
https://developers.google.com/freebase/v1/search-widget#modifying-the-css
https://developers.google.com/freebase/v1/search-widget#how-events-work

We should add to this documentation, the new access option we added, which controls the dataType used for AJAX requests (jsonp (default) or json).

Here are some Wayback Machine links so that we can find them easily in the future:
https://web.archive.org/web/20121116225226/http://wiki.freebase.com/wiki/Freebase_Suggest_Recipes
https://web.archive.org/web/20150909024102/https://developers.google.com/freebase/v1/search-metaschema
https://developers.google.com/freebase/v1/search-overview

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the linked Google and Wayback Machine pages, then inspect OpenRefine's modified Freebase Suggest widget to locate the relevant documentation context. Document the options, CSS customization, events, and the added access option, using either an inline section, a separate file, or the wiki.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.