[
https://issues.apache.org/jira/browse/GEODE-4170?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16308520#comment-16308520
]
ASF GitHub Bot commented on GEODE-4170:
---------------------------------------
karensmolermiller closed pull request #1208: GEODE-4170: Index docs are easier
to locate
URL: https://github.com/apache/geode/pull/1208
This is a PR merged from a forked repository.
As GitHub hides the original diff on merge, it is displayed below for
the sake of provenance:
As this is a foreign pull request (from a fork), the diff is supplied
below (as it won't show otherwise due to GitHub magic):
diff --git a/geode-book/master_middleman/source/subnavs/geode-subnav.erb
b/geode-book/master_middleman/source/subnavs/geode-subnav.erb
index 42115d5e7c..7a9895488a 100644
--- a/geode-book/master_middleman/source/subnavs/geode-subnav.erb
+++ b/geode-book/master_middleman/source/subnavs/geode-subnav.erb
@@ -1206,7 +1206,7 @@ limitations under the License.
<a
href="/docs/guide/<%=vars.product_version_nodot%>/getting_started/querying_quick_reference.html">Geode
Querying FAQ and Examples</a>
</li>
<li class="has_submenu">
- <a
href="/docs/guide/<%=vars.product_version_nodot%>/developing/querying_basics/query_basics.html">Basic
Querying</a>
+ <a
href="/docs/guide/<%=vars.product_version_nodot%>/developing/querying_basics/query_basics.html">Querying
with OQL</a>
<ul>
<li>
<a
href="/docs/guide/<%=vars.product_version_nodot%>/developing/querying_basics/oql_compared_to_sql.html">Advantages
of OQL</a>
@@ -1280,50 +1280,6 @@ limitations under the License.
<li>
<a
href="/docs/guide/<%=vars.product_version_nodot%>/developing/query_additional/using_query_bind_parameters.html">Using
Query Bind Parameters</a>
</li>
- <li class="has_submenu">
- <a
href="/docs/guide/<%=vars.product_version_nodot%>/developing/query_index/query_index.html">Working
with Indexes</a>
- <ul>
- <li>
- <a
href="/docs/guide/<%=vars.product_version_nodot%>/developing/query_index/indexing_guidelines.html">Tips
and Guidelines on Using Indexes</a>
- </li>
- <li>
- <a
href="/docs/guide/<%=vars.product_version_nodot%>/developing/query_index/creating_an_index.html">Creating,
Listing and Removing Indexes</a>
- </li>
- <li>
- <a
href="/docs/guide/<%=vars.product_version_nodot%>/developing/query_index/creating_key_indexes.html">Creating
Key Indexes</a>
- </li>
- <li>
- <a
href="/docs/guide/<%=vars.product_version_nodot%>/developing/query_index/creating_hash_indexes.html">Creating
Hash Indexes</a>
- </li>
- <li>
- <a
href="/docs/guide/<%=vars.product_version_nodot%>/developing/query_index/creating_map_indexes.html">Creating
Indexes on Map Fields ("Map Indexes")</a>
- </li>
- <li>
- <a
href="/docs/guide/<%=vars.product_version_nodot%>/developing/query_index/create_multiple_indexes.html">Creating
Multiple Indexes at Once</a>
- </li>
- <li>
- <a
href="/docs/guide/<%=vars.product_version_nodot%>/developing/query_index/maintaining_indexes.html">Maintaining
Indexes (Synchronously or Asynchronously) and Index Storage</a>
- </li>
- <li>
- <a
href="/docs/guide/<%=vars.product_version_nodot%>/developing/query_index/query_index_hints.html">Using
Query Index Hints</a>
- </li>
- <li>
- <a
href="/docs/guide/<%=vars.product_version_nodot%>/developing/query_index/indexes_on_single_region_queries.html">Using
Indexes on Single Region Queries</a>
- </li>
- <li>
- <a
href="/docs/guide/<%=vars.product_version_nodot%>/developing/query_index/using_indexes_with_equijoin_queries.html">Using
Indexes with Equi-Join Queries</a>
- </li>
- <li>
- <a
href="/docs/guide/<%=vars.product_version_nodot%>/developing/query_index/indexes_with_overflow_regions.html">Using
Indexes with Overflow Regions</a>
- </li>
- <li>
- <a
href="/docs/guide/<%=vars.product_version_nodot%>/developing/query_index/using_indexes_with_equijoin_queries_multiple_regions.html">Using
Indexes on Equi-Join Queries using Multiple Regions</a>
- </li>
- <li>
- <a
href="/docs/guide/<%=vars.product_version_nodot%>/developing/query_index/index_samples.html">Index
Samples</a>
- </li>
- </ul>
- </li>
<li class="has_submenu">
<a
href="/docs/guide/<%=vars.product_version_nodot%>/developing/querying_basics/querying_partitioned_regions.html">
Querying Partitioned Regions</a>
@@ -1350,6 +1306,50 @@ limitations under the License.
</li>
</ul>
</li>
+ <li class="has_submenu">
+ <a
href="/docs/guide/<%=vars.product_version_nodot%>/developing/query_index/query_index.html">Working
with Indexes</a>
+ <ul>
+ <li>
+ <a
href="/docs/guide/<%=vars.product_version_nodot%>/developing/query_index/indexing_guidelines.html">Tips
and Guidelines on Using Indexes</a>
+ </li>
+ <li>
+ <a
href="/docs/guide/<%=vars.product_version_nodot%>/developing/query_index/creating_an_index.html">Creating,
Listing and Removing Indexes</a>
+ </li>
+ <li>
+ <a
href="/docs/guide/<%=vars.product_version_nodot%>/developing/query_index/creating_key_indexes.html">Creating
Key Indexes</a>
+ </li>
+ <li>
+ <a
href="/docs/guide/<%=vars.product_version_nodot%>/developing/query_index/creating_hash_indexes.html">Creating
Hash Indexes</a>
+ </li>
+ <li>
+ <a
href="/docs/guide/<%=vars.product_version_nodot%>/developing/query_index/creating_map_indexes.html">Creating
Indexes on Map Fields ("Map Indexes")</a>
+ </li>
+ <li>
+ <a
href="/docs/guide/<%=vars.product_version_nodot%>/developing/query_index/create_multiple_indexes.html">Creating
Multiple Indexes at Once</a>
+ </li>
+ <li>
+ <a
href="/docs/guide/<%=vars.product_version_nodot%>/developing/query_index/maintaining_indexes.html">Maintaining
Indexes (Synchronously or Asynchronously) and Index Storage</a>
+ </li>
+ <li>
+ <a
href="/docs/guide/<%=vars.product_version_nodot%>/developing/query_index/query_index_hints.html">Using
Query Index Hints</a>
+ </li>
+ <li>
+ <a
href="/docs/guide/<%=vars.product_version_nodot%>/developing/query_index/indexes_on_single_region_queries.html">Using
Indexes on Single Region Queries</a>
+ </li>
+ <li>
+ <a
href="/docs/guide/<%=vars.product_version_nodot%>/developing/query_index/using_indexes_with_equijoin_queries.html">Using
Indexes with Equi-Join Queries</a>
+ </li>
+ <li>
+ <a
href="/docs/guide/<%=vars.product_version_nodot%>/developing/query_index/indexes_with_overflow_regions.html">Using
Indexes with Overflow Regions</a>
+ </li>
+ <li>
+ <a
href="/docs/guide/<%=vars.product_version_nodot%>/developing/query_index/using_indexes_with_equijoin_queries_multiple_regions.html">Using
Indexes on Equi-Join Queries using Multiple Regions</a>
+ </li>
+ <li>
+ <a
href="/docs/guide/<%=vars.product_version_nodot%>/developing/query_index/index_samples.html">Index
Samples</a>
+ </li>
+ </ul>
+ </li>
</ul>
</li>
<li class="has_submenu">
diff --git a/geode-docs/developing/querying_basics/chapter_overview.html.md.erb
b/geode-docs/developing/querying_basics/chapter_overview.html.md.erb
index b7291c829d..5a7e08bbeb 100644
--- a/geode-docs/developing/querying_basics/chapter_overview.html.md.erb
+++ b/geode-docs/developing/querying_basics/chapter_overview.html.md.erb
@@ -27,7 +27,7 @@ Since Geode regions are key-value stores where values can
range from simple byte
This topic answers some frequently asked questions on querying
functionality. It provides examples to help you get started with Geode querying.
-- **[Basic Querying](query_basics.html)**
+- **[Querying with OQL](query_basics.html)**
This section provides a high-level introduction to Geode querying such as
building a query string and describes query language features.
@@ -35,4 +35,7 @@ Since Geode regions are key-value stores where values can
range from simple byte
This section includes advanced querying topics such as using query
indexes, using query bind parameters, querying partitioned regions and query
debugging.
+- **[Working with Indexes](../query_index/query_index.html)**
+
+ The Geode query engine supports indexing. An index can provide significant
performance gains for query execution.
diff --git a/geode-docs/developing/querying_basics/query_basics.html.md.erb
b/geode-docs/developing/querying_basics/query_basics.html.md.erb
index b2928ff6e1..9185f06222 100644
--- a/geode-docs/developing/querying_basics/query_basics.html.md.erb
+++ b/geode-docs/developing/querying_basics/query_basics.html.md.erb
@@ -1,5 +1,5 @@
---
-title: Basic Querying
+title: Querying with OQL
---
<!--
@@ -44,14 +44,3 @@ An important characteristic of <%=vars.product_name%>
querying to note is that b
For those new to the <%=vars.product_name%> querying, see also the
[<%=vars.product_name%> Querying FAQ and
Examples](../../getting_started/querying_quick_reference.html#reference_D5CE64F5FD6F4A808AEFB748C867189E).
-- **[Advantages of OQL](oql_compared_to_sql.html)**
-
-- **[Writing and Executing a Query in
<%=vars.product_name%>](running_a_query.html)**
-
-- **[Building a Query String](what_is_a_query_string.html)**
-
-- **[OQL Syntax and
Semantics](../query_additional/query_language_features.html)**
-
-- **[Query Language Restrictions and Unsupported
Features](restrictions_and_unsupported_features.html)**
-
-
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
[email protected]
> Make index docs easier to locate
> --------------------------------
>
> Key: GEODE-4170
> URL: https://issues.apache.org/jira/browse/GEODE-4170
> Project: Geode
> Issue Type: Improvement
> Components: docs
> Reporter: Karen Smoler Miller
>
> The sections on indexing are buried under the Querying section called
> Advanced Querying. They shouldn't be.
> Promote the indexing section to a first class subsection of Querying.
--
This message was sent by Atlassian JIRA
(v6.4.14#64029)
