RDoc-2342 fix review comments

ravendb · Dec 22, 2024 · d08e26c · d08e26c
1 parent 1975dd7
commit d08e26c
Show file tree

Hide file tree

Showing 8 changed files with 136 additions and 56 deletions.
diff --git a/...entation/5.4/Raven.Documentation.Pages/indexes/what-are-indexes.dotnet.markdown b/...entation/5.4/Raven.Documentation.Pages/indexes/what-are-indexes.dotnet.markdown
@@ -102,19 +102,24 @@ This allows querying for _Employee_ documents by any of the index-fields (`FullN
 #### Define the index
 
 * The first step is to define the index.  
-  One way to do this is by inheriting from the `AbstractIndexCreationTask` class.
-* Other methods for defining an index are described in [Define a static index](../indexes/creating-and-deploying#define-a-static-index).
-  {CODE indexes_1@Indexes/WhatAreIndexes.cs /}
+  One way to do this is by using a custom class that [inherits from AbstractIndexCreationTask](../indexes/creating-and-deploying#static-indexes).  
+* Other methods to create a static-index are:
+    * [Creating a static-index using an Operation](../client-api/operations/maintenance/indexes/put-indexes)
+    * [Creating a static-index from the Studio](../studio/database/indexes/indexes-list-view)
+
+{CODE indexes_1@Indexes/WhatAreIndexes.cs /}
 
 {CONTENT-FRAME/}
 {CONTENT-FRAME: }
 
 #### Deploy the index
 
 * The next step is to deploy the index to the RavenDB server.  
-  Once deployed, the indexing process will start indexing documents.
-* More information on index deployment options can be found in [Deploy the static index](../indexes/creating-and-deploying#deploy-the-static-index).  
-  {CODE indexes_2@Indexes/WhatAreIndexes.cs /}
+  One way to do this is by calling `Execute()` on the index instance.
+* Additional methods for deploying static-indexes are described in [Deploy a static index](../indexes/creating-and-deploying#deploy-a-static-index).
+* Once deployed, the indexing process will start indexing documents.
+
+{CODE indexes_2@Indexes/WhatAreIndexes.cs /}
 
 {CONTENT-FRAME/}
 {CONTENT-FRAME: }
@@ -125,7 +130,8 @@ This allows querying for _Employee_ documents by any of the index-fields (`FullN
   In this example we query for _Employee_ documents, **filtering results based on index-fields** `LastName` and `Country`.
   The results will include only the _Employee_ documents that match the query predicate.
 * For detailed guidance on querying with an index, refer to the [Querying an index](../indexes/querying/query-index).
-  {CODE indexes_3@Indexes/WhatAreIndexes.cs /}
+
+{CODE indexes_3@Indexes/WhatAreIndexes.cs /}
 
 {CONTENT-FRAME/}
 {PANEL/}
@@ -145,6 +151,8 @@ which let you project the query results into selected fields instead of returnin
 
 ---
 
+#### Viewing the resulting documents:
+
 For example, the results shown in the following image are the **documents** that match the query predicate.
 
 ![Index query results - documents](images/index-query-results-1.png "Query results - Documents")
@@ -156,6 +164,8 @@ For example, the results shown in the following image are the **documents** that
 
 ---
 
+#### Viewing the index-entries:
+
 If you wish to **view the index-entries** that compose the index itself,  
 you can enable the option to show "raw index entries" instead of the matching documents.
 

diff --git a/Documentation/5.4/Raven.Documentation.Pages/indexes/what-are-indexes.java.markdown b/Documentation/5.4/Raven.Documentation.Pages/indexes/what-are-indexes.java.markdown
@@ -102,19 +102,24 @@ This allows querying for _Employee_ documents by any of the index-fields (`FullN
 #### Define the index
 
 * The first step is to define the index.  
-  One way to do this is by extending the `AbstractIndexCreationTask` class.
-* Other methods for defining an index are described in [Define a static index](../indexes/creating-and-deploying#define-a-static-index).
-  {CODE:java indexes_1@Indexes/WhatAreIndexes.java /}
+  One way to do this is by using a custom class that [extends the AbstractIndexCreationTask class](../indexes/creating-and-deploying#static-indexes).
+* Other methods to create a static-index are:
+  * [Creating a static-index using an Operation](../client-api/operations/maintenance/indexes/put-indexes)
+  * [Creating a static-index from the Studio](../studio/database/indexes/indexes-list-view)
+
+{CODE:java indexes_1@Indexes/WhatAreIndexes.java /}
 
 {CONTENT-FRAME/}
 {CONTENT-FRAME: }
 
 #### Deploy the index
 
 * The next step is to deploy the index to the RavenDB server.  
-  Once deployed, the indexing process will start indexing documents.
-* More information on index deployment options can be found in [Deploy the static index](../indexes/creating-and-deploying#deploy-the-static-index).  
-  {CODE:java indexes_2@Indexes/WhatAreIndexes.java /}
+  One way to do this is by calling `execute()` on the index instance.  
+* Additional methods for deploying static-indexes are described in [Deploy a static index](../indexes/creating-and-deploying#deploy-a-static-index).  
+* Once deployed, the indexing process will start indexing documents.  
+
+{CODE:java indexes_2@Indexes/WhatAreIndexes.java /}
 
 {CONTENT-FRAME/}
 {CONTENT-FRAME: }
@@ -125,7 +130,8 @@ This allows querying for _Employee_ documents by any of the index-fields (`FullN
   In this example we query for _Employee_ documents, **filtering results based on index-fields** `LastName` and `Country`.
   The results will include only the _Employee_ documents that match the query predicate.
 * For detailed guidance on querying with an index, refer to the [Querying an index](../indexes/querying/query-index).
-  {CODE:java indexes_3@Indexes/WhatAreIndexes.java /}
+
+{CODE:java indexes_3@Indexes/WhatAreIndexes.java /}
 
 {CONTENT-FRAME/}
 {PANEL/}
@@ -145,6 +151,8 @@ which let you project the query results into selected fields instead of returnin
 
 ---
 
+#### Viewing the resulting documents:
+
 For example, the results shown in the following image are the **documents** that match the query predicate.
 
 ![Index query results - documents](images/index-query-results-1.png "Query results - Documents")
@@ -156,6 +164,8 @@ For example, the results shown in the following image are the **documents** that
 
 ---
 
+#### Viewing the index-entries:
+
 If you wish to **view the index-entries** that compose the index itself,  
 you can enable the option to show "raw index entries" instead of the matching documents.
 

diff --git a/Documentation/5.4/Raven.Documentation.Pages/indexes/what-are-indexes.js.markdown b/Documentation/5.4/Raven.Documentation.Pages/indexes/what-are-indexes.js.markdown
@@ -102,19 +102,24 @@ This allows querying for _Employee_ documents by any of the index-fields (`FullN
 #### Define the index
 
 * The first step is to define the index.  
-  One way to do this is by extending the `AbstractJavaScriptIndexCreationTask` class.
-* Other methods for defining an index are described in [Define a static index](../indexes/creating-and-deploying#define-a-static-index).
-  {CODE:nodejs indexes_1@indexes/whatAreIndexes.js /}
+  One way to do this is by using a custom class that [extends AbstractJavaScriptIndexCreationTask](../indexes/creating-and-deploying#static-indexes).
+* Other methods to create a static-index are:
+  * [Creating a static-index using an Operation](../client-api/operations/maintenance/indexes/put-indexes)
+  * [Creating a static-index from the Studio](../studio/database/indexes/indexes-list-view)
+
+{CODE:nodejs indexes_1@indexes/whatAreIndexes.js /}
 
 {CONTENT-FRAME/}
 {CONTENT-FRAME: }
 
 #### Deploy the index
 
 * The next step is to deploy the index to the RavenDB server.  
-  Once deployed, the indexing process will start indexing documents.
-* More information on index deployment options can be found in [Deploy the static index](../indexes/creating-and-deploying#deploy-the-static-index).  
-  {CODE:nodejs indexes_2@indexes/whatAreIndexes.js /}
+  One way to do this is by calling `execute()` on the index instance.
+* Additional methods for deploying static-indexes are described in [Deploy a static index](../indexes/creating-and-deploying#deploy-a-static-index).
+* Once deployed, the indexing process will start indexing documents.  
+
+{CODE:nodejs indexes_2@indexes/whatAreIndexes.js /}
 
 {CONTENT-FRAME/}
 {CONTENT-FRAME: }
@@ -125,7 +130,8 @@ This allows querying for _Employee_ documents by any of the index-fields (`FullN
   In this example we query for _Employee_ documents, **filtering results based on index-fields** `LastName` and `Country`.
   The results will include only the _Employee_ documents that match the query predicate.
 * For detailed guidance on querying with an index, refer to the [Querying an index](../indexes/querying/query-index).
-  {CODE:nodejs indexes_3@indexes/whatAreIndexes.js /}
+
+{CODE:nodejs indexes_3@indexes/whatAreIndexes.js /}
 
 {CONTENT-FRAME/}
 {PANEL/}
@@ -145,6 +151,8 @@ which let you project the query results into selected fields instead of returnin
 
 ---
 
+#### Viewing the resulting documents:
+
 For example, the results shown in the following image are the **documents** that match the query predicate.
 
 ![Index query results - documents](images/index-query-results-1.png "Query results - Documents")
@@ -156,6 +164,8 @@ For example, the results shown in the following image are the **documents** that
 
 ---
 
+#### Viewing the index-entries:
+
 If you wish to **view the index-entries** that compose the index itself,  
 you can enable the option to show "raw index entries" instead of the matching documents.
 

diff --git a/...entation/5.4/Raven.Documentation.Pages/indexes/what-are-indexes.python.markdown b/...entation/5.4/Raven.Documentation.Pages/indexes/what-are-indexes.python.markdown
@@ -102,19 +102,24 @@ This allows querying for _Employee_ documents by any of the index-fields (`FullN
 #### Define the index
 
 * The first step is to define the index.  
-  One way to do this is to inherit from the `AbstractIndexCreationTask` class.
-* Other methods for defining an index are described in [Define a static index](../indexes/creating-and-deploying#define-a-static-index).
-  {CODE:python indexes_1@Indexes/WhatAreIndexes.py /}
+  One way to do this is by using a custom class that [inherits from AbstractIndexCreationTask](../indexes/creating-and-deploying#static-indexes).
+* Other methods to create a static-index are:
+  * [Creating a static-index using an Operation](../client-api/operations/maintenance/indexes/put-indexes)
+  * [Creating a static-index from the Studio](../studio/database/indexes/indexes-list-view)
+
+{CODE:python indexes_1@Indexes/WhatAreIndexes.py /}
 
 {CONTENT-FRAME/}
 {CONTENT-FRAME: }
 
 #### Deploy the index
 
 * The next step is to deploy the index to the RavenDB server.  
-  Once deployed, the indexing process will start indexing documents.
-* More information on index deployment options can be found in [Deploy the static index](../indexes/creating-and-deploying#deploy-the-static-index).  
-  {CODE:python indexes_2@Indexes/WhatAreIndexes.py /}
+  One way to do this is by calling `execute()` on the index instance.
+* Additional methods for deploying static-indexes are described in [Deploy a static index](../indexes/creating-and-deploying#deploy-a-static-index).
+* Once deployed, the indexing process will start indexing documents.  
+
+{CODE:python indexes_2@Indexes/WhatAreIndexes.py /}
 
 {CONTENT-FRAME/}
 {CONTENT-FRAME: }
@@ -125,7 +130,8 @@ This allows querying for _Employee_ documents by any of the index-fields (`FullN
   In this example we query for _Employee_ documents, **filtering results based on index-fields** `LastName` and `Country`.
   The results will include only the _Employee_ documents that match the query predicate.
 * For detailed guidance on querying with an index, refer to the [Querying an index](../indexes/querying/query-index).
-  {CODE:python indexes_3@Indexes/WhatAreIndexes.py /}
+
+{CODE:python indexes_3@Indexes/WhatAreIndexes.py /}
 
 {CONTENT-FRAME/}
 {PANEL/}
@@ -145,6 +151,8 @@ which let you project the query results into selected fields instead of returnin
 
 ---
 
+#### Viewing the resulting documents:
+
 For example, the results shown in the following image are the **documents** that match the query predicate.
 
 ![Index query results - documents](images/index-query-results-1.png "Query results - Documents")
@@ -156,6 +164,8 @@ For example, the results shown in the following image are the **documents** that
 
 ---
 
+#### Viewing the index-entries:
+
 If you wish to **view the index-entries** that compose the index itself,  
 you can enable the option to show "raw index entries" instead of the matching documents.
 

diff --git a/...entation/6.0/Raven.Documentation.Pages/indexes/what-are-indexes.dotnet.markdown b/...entation/6.0/Raven.Documentation.Pages/indexes/what-are-indexes.dotnet.markdown
@@ -102,19 +102,24 @@ This allows querying for _Employee_ documents by any of the index-fields (`FullN
 #### Define the index
 
 * The first step is to define the index.  
-  One way to do this is by inheriting from the `AbstractIndexCreationTask` class.
-* Other methods for defining an index are described in [Define a static index](../indexes/creating-and-deploying#define-a-static-index).
-  {CODE indexes_1@Indexes/WhatAreIndexes.cs /}
+  One way to do this is by using a custom class that [inherits from AbstractIndexCreationTask](../indexes/creating-and-deploying#static-indexes).  
+* Other methods to create a static-index are:
+    * [Creating a static-index using an Operation](../client-api/operations/maintenance/indexes/put-indexes)
+    * [Creating a static-index from the Studio](../studio/database/indexes/indexes-list-view)
+
+{CODE indexes_1@Indexes/WhatAreIndexes.cs /}
 
 {CONTENT-FRAME/}
 {CONTENT-FRAME: }
 
 #### Deploy the index
 
 * The next step is to deploy the index to the RavenDB server.  
-  Once deployed, the indexing process will start indexing documents.
-* More information on index deployment options can be found in [Deploy the static index](../indexes/creating-and-deploying#deploy-the-static-index).  
-  {CODE indexes_2@Indexes/WhatAreIndexes.cs /}
+  One way to do this is by calling `Execute()` on the index instance.  
+* Additional methods for deploying static-indexes are described in [Deploy a static index](../indexes/creating-and-deploying#deploy-a-static-index).  
+* Once deployed, the indexing process will start indexing documents.  
+
+{CODE indexes_2@Indexes/WhatAreIndexes.cs /}
 
 {CONTENT-FRAME/}
 {CONTENT-FRAME: }
@@ -125,7 +130,8 @@ This allows querying for _Employee_ documents by any of the index-fields (`FullN
   In this example we query for _Employee_ documents, **filtering results based on index-fields** `LastName` and `Country`.
   The results will include only the _Employee_ documents that match the query predicate.
 * For detailed guidance on querying with an index, refer to the [Querying an index](../indexes/querying/query-index).
-  {CODE indexes_3@Indexes/WhatAreIndexes.cs /}
+
+{CODE indexes_3@Indexes/WhatAreIndexes.cs /}
 
 {CONTENT-FRAME/}
 {PANEL/}
@@ -145,6 +151,8 @@ which let you project the query results into selected fields instead of returnin
 
 ---
 
+#### Viewing the resulting documents:
+
 For example, the results shown in the following image are the **documents** that match the query predicate.
 
 ![Index query results - documents](images/index-query-results-1.png "Query results - Documents")
@@ -156,6 +164,8 @@ For example, the results shown in the following image are the **documents** that
 
 ---
 
+#### Viewing the index-entries:
+
 If you wish to **view the index-entries** that compose the index itself,  
 you can enable the option to show "raw index entries" instead of the matching documents.
 

diff --git a/Documentation/6.0/Raven.Documentation.Pages/indexes/what-are-indexes.java.markdown b/Documentation/6.0/Raven.Documentation.Pages/indexes/what-are-indexes.java.markdown
@@ -102,19 +102,24 @@ This allows querying for _Employee_ documents by any of the index-fields (`FullN
 #### Define the index
 
 * The first step is to define the index.  
-  One way to do this is by extending the `AbstractIndexCreationTask` class.
-* Other methods for defining an index are described in [Define a static index](../indexes/creating-and-deploying#define-a-static-index).
-  {CODE:java indexes_1@Indexes/WhatAreIndexes.java /}
+  One way to do this is by using a custom class that [extends the AbstractIndexCreationTask class](../indexes/creating-and-deploying#static-indexes).
+* Other methods to create a static-index are:  
+  * [Creating a static-index using an Operation](../client-api/operations/maintenance/indexes/put-indexes)
+  * [Creating a static-index from the Studio](../studio/database/indexes/indexes-list-view)
+
+{CODE:java indexes_1@Indexes/WhatAreIndexes.java /}
 
 {CONTENT-FRAME/}
 {CONTENT-FRAME: }
 
 #### Deploy the index
 
 * The next step is to deploy the index to the RavenDB server.  
-  Once deployed, the indexing process will start indexing documents.
-* More information on index deployment options can be found in [Deploy the static index](../indexes/creating-and-deploying#deploy-the-static-index).  
-  {CODE:java indexes_2@Indexes/WhatAreIndexes.java /}
+  One way to do this is by calling `execute()` on the index instance.
+* Additional methods for deploying static-indexes are described in [Deploy a static index](../indexes/creating-and-deploying#deploy-a-static-index).
+* Once deployed, the indexing process will start indexing documents.  
+
+{CODE:java indexes_2@Indexes/WhatAreIndexes.java /}
 
 {CONTENT-FRAME/}
 {CONTENT-FRAME: }
@@ -125,7 +130,8 @@ This allows querying for _Employee_ documents by any of the index-fields (`FullN
   In this example we query for _Employee_ documents, **filtering results based on index-fields** `LastName` and `Country`.
   The results will include only the _Employee_ documents that match the query predicate.
 * For detailed guidance on querying with an index, refer to the [Querying an index](../indexes/querying/query-index).
-  {CODE:java indexes_3@Indexes/WhatAreIndexes.java /}
+
+{CODE:java indexes_3@Indexes/WhatAreIndexes.java /}
 
 {CONTENT-FRAME/}
 {PANEL/}
@@ -145,6 +151,8 @@ which let you project the query results into selected fields instead of returnin
 
 ---
 
+#### Viewing the resulting documents:
+
 For example, the results shown in the following image are the **documents** that match the query predicate.
 
 ![Index query results - documents](images/index-query-results-1.png "Query results - Documents")
@@ -156,6 +164,8 @@ For example, the results shown in the following image are the **documents** that
 
 ---
 
+#### Viewing the index-entries:
+
 If you wish to **view the index-entries** that compose the index itself,  
 you can enable the option to show "raw index entries" instead of the matching documents.