You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@flink.apache.org by "ASF GitHub Bot (JIRA)" <ji...@apache.org> on 2017/07/10 08:14:00 UTC
[jira] [Commented] (FLINK-7136) Docs search can be customized to be
more useful
[ https://issues.apache.org/jira/browse/FLINK-7136?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16080004#comment-16080004 ]
ASF GitHub Bot commented on FLINK-7136:
---------------------------------------
GitHub user alpinegizmo opened a pull request:
https://github.com/apache/flink/pull/4291
[FLINK-7136][docs] Improve search by adding facets and turning off ads
This PR expands the custom search engine used by the documentation to include some additional sources, and expands the UI to include tabs for breaking out the results by source, and turns off ads (which we are entitled to do, since the ASF is a non-profit org).
The specifications for the list of sites to be searched, their weights, and the UI are checked in as XML files. However, editing these files won't have any direct impact. Instead, they must be re-uploaded to the google custom search console. The reason to check them in is to make the search settings visible, and to preserve a copy of all the settings within the project.
Before and after screenshots when searching for "timers":
<img width="930" alt="screen shot 2017-07-10 at 10 11 39 am" src="https://user-images.githubusercontent.com/43608/28008542-3ae67428-6558-11e7-881a-5e79369ef9d3.png">
<img width="868" alt="screen shot 2017-07-10 at 10 12 44 am" src="https://user-images.githubusercontent.com/43608/28008577-60e11fca-6558-11e7-82f5-e28c7c9f364a.png">
You can merge this pull request into a Git repository by running:
$ git pull https://github.com/alpinegizmo/flink 7136-doc-search
Alternatively you can review and apply these changes as the patch at:
https://github.com/apache/flink/pull/4291.patch
To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:
This closes #4291
----
commit 9f2ed8cbae957b030774d48ac4206904d7cb8385
Author: David Anderson <da...@alpinegizmo.com>
Date: 2017-07-07T20:54:17Z
[FLINK-7136][docs] Improve search by adding facets and turning off ads
----
> Docs search can be customized to be more useful
> -----------------------------------------------
>
> Key: FLINK-7136
> URL: https://issues.apache.org/jira/browse/FLINK-7136
> Project: Flink
> Issue Type: Improvement
> Components: Documentation
> Affects Versions: 1.4.0
> Reporter: David Anderson
> Assignee: David Anderson
>
> The google custom search engine we're using for search can be customized to make it more useful.
> I propose to
> * turn off ads (which is allowed, since this site belongs to a non-profit org)
> * add additional sources of information (mailing lists, JIRA, flips, stack overflow, flink forward)
> * use refinements (tabs) to make it easy to navigate between these sources
--
This message was sent by Atlassian JIRA
(v6.4.14#64029)