You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@flink.apache.org by se...@apache.org on 2017/07/11 20:12:14 UTC
[4/4] flink git commit: [FLINK-7136] [docs] Improve search by adding
facets and turning off ads
[FLINK-7136] [docs] Improve search by adding facets and turning off ads
This closes #4291
Project: http://git-wip-us.apache.org/repos/asf/flink/repo
Commit: http://git-wip-us.apache.org/repos/asf/flink/commit/251fb984
Tree: http://git-wip-us.apache.org/repos/asf/flink/tree/251fb984
Diff: http://git-wip-us.apache.org/repos/asf/flink/diff/251fb984
Branch: refs/heads/master
Commit: 251fb98450b048b5dbba6770a27eebf6ddd95885
Parents: 9ff92c9
Author: David Anderson <da...@alpinegizmo.com>
Authored: Fri Jul 7 22:54:17 2017 +0200
Committer: Stephan Ewen <se...@apache.org>
Committed: Tue Jul 11 21:58:13 2017 +0200
----------------------------------------------------------------------
docs/_includes/sidenav.html | 2 +-
docs/annotations.xml | 66 +++++++++++++++++++++++++++++++
docs/cse.xml | 85 ++++++++++++++++++++++++++++++++++++++++
docs/search-results.md | 9 ++---
4 files changed, 156 insertions(+), 6 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/flink/blob/251fb984/docs/_includes/sidenav.html
----------------------------------------------------------------------
diff --git a/docs/_includes/sidenav.html b/docs/_includes/sidenav.html
index fc9c1b6..7afc5f1 100644
--- a/docs/_includes/sidenav.html
+++ b/docs/_includes/sidenav.html
@@ -133,7 +133,7 @@ level is determined by 'nav-pos'.
<div class="sidenav-search-box">
<form class="navbar-form" role="search" action="{{site.baseurl}}/search-results.html">
<div class="form-group">
- <input type="text" class="form-control" size="16px" name="q" placeholder="Search Docs">
+ <input type="text" class="form-control" size="16px" name="q" placeholder="Search">
</div>
<button type="submit" class="btn btn-default">Go</button>
</form>
http://git-wip-us.apache.org/repos/asf/flink/blob/251fb984/docs/annotations.xml
----------------------------------------------------------------------
diff --git a/docs/annotations.xml b/docs/annotations.xml
new file mode 100644
index 0000000..a857770
--- /dev/null
+++ b/docs/annotations.xml
@@ -0,0 +1,66 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+
+<!--
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied. See the License for the
+specific language governing permissions and limitations
+under the License.
+-->
+
+<?ignore
+This is the annotations file for the Google Custom Search Engine
+used by the Apache Flink Documentation after version 1.3.
+After modifying this file it needs to be uploaded to the Custom Search control panel at
+https://cse.google.com/cse/setup/advanced?cx=000322205049649384055%3Aqbxxlwnwoqs
+in order for the changes to take effect.
+The UI is specified separately in cse.xml.
+?>
+
+<Annotations start="0" num="7" total="7">
+ <Annotation score="1" about="ci.apache.org/projects/flink/flink-docs-master/*" timestamp="0x0005539172a442a2" href="CjBjaS5hcGFjaGUub3JnL3Byb2plY3RzL2ZsaW5rL2ZsaW5rLWRvY3MtbWFzdGVyLyoQooWRlZfy1AI">
+ <Label name="_cse_qbxxlwnwoqs" />
+ <Label name="documentation" />
+ <AdditionalData attribute="original_url" value="https://ci.apache.org/projects/flink/flink-docs-master/" />
+ </Annotation>
+ <Annotation score="0.2" about="issues.apache.org/jira/browse/FLINK-*" timestamp="0x000553938050ff8b" href="CiVpc3N1ZXMuYXBhY2hlLm9yZy9qaXJhL2Jyb3dzZS9GTElOSy0qEIv_w4K48tQC">
+ <Label name="_cse_qbxxlwnwoqs" />
+ <Label name="jira" />
+ <AdditionalData attribute="original_url" value="https://issues.apache.org/jira/browse/FLINK-*" />
+ </Annotation>
+ <Annotation score="0.5" about="mail-archives.apache.org/mod_mbox/flink-*" timestamp="0x000553917ae594ac" href="Ci1tYWlsLWFyY2hpdmVzLmFwYWNoZS5vcmcvbW9kX21ib3gvZmxpbmstZGV2LyoQrKmW15fy1AI">
+ <Label name="_cse_qbxxlwnwoqs" />
+ <Label name="mailing_lists" />
+ <AdditionalData attribute="original_url" value="https://mail-archives.apache.org/mod_mbox/flink-*" />
+ </Annotation>
+ <Annotation score="0.5" about="cwiki.apache.org/confluence/display/FLINK/FLIP-*">
+ <Label name="_cse_qbxxlwnwoqs" />
+ <Label name="flips" />
+ <AdditionalData attribute="original_url" value="https://cwiki.apache.org/confluence/display/FLINK/FLIP-*" />
+ </Annotation>
+ <Annotation score="0.5" about="*.flink-forward.org/*">
+ <Label name="_cse_qbxxlwnwoqs" />
+ <Label name="FF" />
+ </Annotation>
+ <Annotation score="0.001" about="*.stackoverflow.com/*" timestamp="0x000553943f18494c" href="ChUqLnN0YWNrb3ZlcmZsb3cuY29tLyoQzJLh-MPy1AI">
+ <Label name="_cse_qbxxlwnwoqs" />
+ <Label name="stack_overflow" />
+ <AdditionalData attribute="original_url" value="https://stackoverflow.com" />
+ </Annotation>
+ <Annotation about="ci.apache.org/projects/flink/flink-docs-master/api/java/*" timestamp="0x0005539459e4638b" href="CjljaS5hcGFjaGUub3JnL3Byb2plY3RzL2ZsaW5rL2ZsaW5rLWRvY3MtbWFzdGVyL2FwaS9qYXZhLyoQi8eRz8Xy1AI">
+ <Label name="_cse_exclude_qbxxlwnwoqs" />
+ <Label name="javadocs" />
+ <AdditionalData attribute="original_url" value="https://ci.apache.org/projects/flink/flink-docs-master/api/java/" />
+ </Annotation>
+</Annotations>
http://git-wip-us.apache.org/repos/asf/flink/blob/251fb984/docs/cse.xml
----------------------------------------------------------------------
diff --git a/docs/cse.xml b/docs/cse.xml
new file mode 100644
index 0000000..a0cd0db
--- /dev/null
+++ b/docs/cse.xml
@@ -0,0 +1,85 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+
+<!--
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied. See the License for the
+specific language governing permissions and limitations
+under the License.
+-->
+
+<?ignore
+This file specifies the refinements (facets) and look and feel of the Google Custom Search Engine
+used by the Apache Flink Documentation after version 1.3.
+After modifying this file it needs to be uploaded to the Custom Search control panel at
+https://cse.google.com/cse/setup/advanced?cx=000322205049649384055%3Aqbxxlwnwoqs
+in order for the changes to take effect.
+The sites to be searched are specified separately in annotations.xml.
+?>
+
+<CustomSearchEngine id="qbxxlwnwoqs" creator="000322205049649384055" language="en" top_refinements="2147483647" encoding="UTF-8" enable_suggest="true">
+ <Title>flink-test</Title>
+ <Context>
+ <Facet>
+ <FacetItem>
+ <Label name="documentation" mode="FILTER">
+ <Rewrite></Rewrite>
+ </Label>
+ <Title>Docs</Title>
+ </FacetItem>
+ <FacetItem>
+ <Label name="mailing_lists" mode="FILTER">
+ <Rewrite></Rewrite>
+ </Label>
+ <Title>Mailing Lists</Title>
+ </FacetItem>
+ <FacetItem>
+ <Label name="jira" mode="FILTER">
+ <Rewrite></Rewrite>
+ </Label>
+ <Title>Issues</Title>
+ </FacetItem>
+ <FacetItem>
+ <Label name="stack_overflow" mode="FILTER">
+ <Rewrite></Rewrite>
+ </Label>
+ <Title>Stack Overflow</Title>
+ </FacetItem>
+ <FacetItem>
+ <Label name="flips" mode="FILTER">
+ <Rewrite></Rewrite>
+ </Label>
+ <Title>FLIPs</Title>
+ </FacetItem>
+ </Facet>
+ <BackgroundLabels>
+ <Label name="_cse_qbxxlwnwoqs" mode="FILTER" />
+ <Label name="_cse_exclude_qbxxlwnwoqs" mode="ELIMINATE" />
+ </BackgroundLabels>
+ </Context>
+ <LookAndFeel nonprofit="true" element_layout="5" theme="1" custom_theme="true" text_font="Arial, sans-serif" url_length="full" element_branding="show" enable_cse_thumbnail="true" promotion_url_length="full" ads_layout="1">
+ <Logo />
+ <Colors url="#008000" background="#FFFFFF" border="#FFFFFF" title="#0000CC" text="#000000" visited="#0000CC" title_hover="#0000CC" title_active="#0000CC" />
+ <Promotions title_color="#0000CC" title_visited_color="#0000CC" url_color="#008000" background_color="#FFFFFF" border_color="#336699" snippet_color="#000000" title_hover_color="#0000CC" title_active_color="#0000CC" />
+ <SearchControls input_border_color="#D9D9D9" button_border_color="#666666" button_background_color="#CECECE" tab_border_color="#E9E9E9" tab_background_color="#E9E9E9" tab_selected_border_color="#FF9900" tab_selected_background_color="#FFFFFF" />
+ <Results border_color="#FFFFFF" border_hover_color="#FFFFFF" background_color="#FFFFFF" background_hover_color="#FFFFFF" ads_background_color="#fff7f5" ads_border_color="#FFFFFF" />
+ </LookAndFeel>
+ <AdSense />
+ <EnterpriseAccount />
+ <ImageSearchSettings enable="false" />
+ <autocomplete_settings />
+ <sort_by_keys label="Relevance" key="" />
+ <sort_by_keys label="Date" key="date" />
+ <cse_advance_settings enable_speech="true" enable_facet_search="true" />
+</CustomSearchEngine>
http://git-wip-us.apache.org/repos/asf/flink/blob/251fb984/docs/search-results.md
----------------------------------------------------------------------
diff --git a/docs/search-results.md b/docs/search-results.md
index 11f7e4f..2c37b44 100644
--- a/docs/search-results.md
+++ b/docs/search-results.md
@@ -21,15 +21,14 @@ under the License.
-->
<script>
(function() {
- var cx = '000888944958067045520:z90hn2izm0k';
+ var cx = '000322205049649384055:qbxxlwnwoqs';
var gcse = document.createElement('script');
gcse.type = 'text/javascript';
gcse.async = true;
- gcse.src = (document.location.protocol == 'https:' ? 'https:' : 'http:') +
- '//www.google.com/cse/cse.js?cx=' + cx;
+ gcse.src = 'https://cse.google.com/cse.js?cx=' + cx;
var s = document.getElementsByTagName('script')[0];
s.parentNode.insertBefore(gcse, s);
})();
</script>
-
-<gcse:searchresults-only></gcse:searchresults-only>
+<!-- add the keyword flink to every search -->
+<gcse:search as_oq="flink"></gcse:search>