Consistency 2023-02-16 (#1278)

* Formatting, style, typos

* Fix typos, apply to 3.10

* Fix Liquid warnings

* Remove incorrectly added 3.11-only DocuBlock

* Fix typos that depend on arangodb/arangodb#17471

* can not -> cannot

* Review feedback

* Update examples for 3.11 in consistency-2023-02-16 at 2023-03-06T16:44:32+00:00

Author: Simran-B

3.10/administration-configuration.md

@@ -173,26 +173,26 @@ Specific to arangod, move to programs detail page?
 Does the resolution order for config files apply to all binaries?
 Linux only? Also macOS? Windows not addressed so far.
 
-If this command is not passed to the server, then by default, the server will
-attempt to first locate a file named *~/.arango/arangod.conf* in the user's home
+If this command is not passed to the server, then by default, the server
+attempts to first locate a file named `~/.arango/arangod.conf` in the user's home
 directory.
 
-If no such file is found, the server will proceed to look for a file
-*arangod.conf* in the system configuration directory. The system configuration
+If no such file is found, the server proceeds to look for a file
+`arangod.conf` in the system configuration directory. The system configuration
 directory is platform-specific, and may be changed when compiling ArangoDB
-yourself. It may default to */etc/arangodb* or */usr/local/etc/arangodb*. This
+yourself. It may default to `/etc/arangodb` or `/usr/local/etc/arangodb`. This
 file is installed when using a package manager like rpm or dpkg. If you modify
 this file and later upgrade to a new version of ArangoDB, then the package
 manager normally warns you about the conflict. In order to avoid these warning
 for small adjustments, you can put local overrides into a file
-*arangod.conf.local*.
+`arangod.conf.local`.
 {% endcomment %}
 
 ## Suffixes for Numeric Options
 
-It is possible to add suffixes to numeric options that will cause ArangoDB to
-multiply the value by a certain factor. This can be used to conveniently specify
-values in megabytes or gigabytes for example.
+You can add suffixes to numeric options to let ArangoDB multiply the value by a
+certain factor. This allows you to conveniently specify values, for example,
+in megabytes or gigabytes.
 
 | Suffix               | Factor   | Example |
 |----------------------|----------|---------|
@@ -204,7 +204,7 @@ values in megabytes or gigabytes for example.
 | `g`, `G`, `gb`, `GB` | 1000 ^ 3 | 3GB     |
 | `%`                  | 0.01     | 5%      |
 
-Suffix could be used like this in a configuration file:
+You can also use suffixes in configuration files like this:
 
 ```conf
 [rocksdb]
@@ -284,29 +284,29 @@ level = startup=info
 There are built-in defaults, with which all configuration variables are first
 initialized. They can be overridden by configuration files and command line
 options (in this order). Only a fraction of all available options are set in
-the configuration files that ArangoDB ships with. Many options will therefore
+the configuration files that ArangoDB ships with. Many options therefore
 fall back to the built-in defaults unless they are overridden by the user.
 
 It is common to use modified configuration files together with startup
 options on a command line to override specific settings. Command line options
 take precedence over values set in a configuration file.
 
 If the same option is set multiple times, but only supports a single value,
-then the last occurrence of the option will become the final value.
-For example, if you edit `arangosh.conf` to set:
+then the last occurrence of the option becomes the final value.
+For example, if you edit `arangosh.conf` as follows:
 
-```
+```conf
 server.database = myDB1
 server.database = myDB2
 ```
 
-… and start ArangoShell like:
+Then start ArangoShell like this:
 
 ```
 arangosh --server.database myDB3 --server.database myDB4
 ```
 
-… then the database it will connect to is `myDB4`, because this startup option
+The database it connects to is `myDB4`, because this startup option
 takes a single value only (i.e. it is not a vector), the built-in default
 is `_system` but the configuration file overrules the setting. It gets set to
 `myDB1` temporarily before it is replaced by `myDB2`, which in turn gets
@@ -315,7 +315,7 @@ final value `myDB4`.
 
 ## Change configuration at runtime
 
-In general, supplied startup options can not be changed nor can configuration
+In general, supplied startup options cannot be changed nor can configuration
 files be reloaded once an executable is started, other than by restarting the
 executable with different options. However, some of the startup options
 define default values which can be overridden on a per-query basis for

3.10/administration-log-levels.md

@@ -36,7 +36,7 @@ The meaning of each log level is described below.
 ## FATAL
 
 _Fatal_ errors are the most severe errors and only occur if a service or application
-can not recover safely from an abnormal state, which forces it to shut down.
+cannot recover safely from an abnormal state, which forces it to shut down.
 
 Typically, a fatal error only occurs once in the process lifetime,
 so if the log file is tied to the process, this is typically

3.10/administration-managing-users.md

@@ -282,7 +282,7 @@ Database `shop2`, collection `reviews` does not match a defined access
 level. However, database `shop2` matches and the wildcard in this
 database for collection level is *Read-Only*.
 
-Database `somehing`, collection `else` does not match a defined access
+Database `something`, collection `else` does not match a defined access
 level. The database `something` also does have a direct matches.
 Therefore the wildcard is selected. The level is *Read/Write*.
 

3.10/administration-reduce-memory-footprint.md

@@ -151,9 +151,9 @@ has to work with collections at the cost of main memory.
 In ArangoDB version 3.4 we introduced
 [streaming cursors](release-notes-new-features34.html#streaming-aql-cursors) with
 somewhat inverted properties: less peak memory usage, longer access to the
-collections. Streaming is possible on document level, which means that it can not
+collections. Streaming is possible on document level, which means that it cannot
 be applied to all query parts. For example, a *MERGE()* of all results of a
-subquery can not be streamed (the result of the operation has to be built up fully).
+subquery cannot be streamed (the result of the operation has to be built up fully).
 Nonetheless, the surrounding query may be eligible for streaming.
 
 Aside from streaming cursors, ArangoDB offers the possibility to specify a
@@ -218,7 +218,7 @@ JavaScript:
 This will limit the number of V8 isolates to two. All JavaScript related
 requests will be queued up until one of the isolates becomes available for the
 new task. It also restricts the heap size to 512 MByte, so that both V8 contexts
-combined can not use more than 1 GByte of memory in the worst case.
+combined cannot use more than 1 GByte of memory in the worst case.
 
 ### V8 for the Desperate
 
@@ -279,7 +279,7 @@ Also see the [_arangod_ startup options](programs-arangod-options.html#--servero
 CPU usage
 ---------
 
-We can not really reduce CPU usage, but the number of threads running in parallel.
+We cannot really reduce CPU usage, but the number of threads running in parallel.
 Again, you should not do this unless there are very good reasons, like an
 embedded system. Note that this will limit the performance for concurrent
 requests, which may be okay for a local development system with you as only 

3.10/analyzers.md

@@ -80,13 +80,13 @@ array level and let the configured Analyzer process the individual elements by
 using `[*]` as a suffix for a field in the index definition. Primitive values
 other than strings are indexed as-is.
 
-Analyzers can not process objects as a whole. However, you can work with
+Analyzers cannot process objects as a whole. However, you can work with
 individual object attributes. You can use inverted indexes and Views to index
 specific object attributes or sub-attributes, or index all sub-attributes with
 the `includeAllFields` option enabled. Each non-object value is handled as
 described above. Sub-objects in arrays can be indexed, too (with limitations).
-However, only primitive values are added to the index. Arrays and objects can
-not be searched for as a whole.
+However, only primitive values are added to the index. Arrays and objects
+cannot be searched for as a whole.
 
 Also see:
 - [`SEARCH` operation](aql/operations-search.html) on how to query indexed
@@ -117,7 +117,7 @@ The names get prefixed with the database name and two colons, e.g.
 Custom Analyzers stored in the `_system` database can be referenced in queries
 against other databases by specifying the prefixed name, e.g.
 `_system::customGlobalAnalyzer`. Analyzers stored in databases other than
-`_system` can not be accessed from within another database however.
+`_system` cannot be accessed from within another database however.
 
 Analyzer Types
 --------------
@@ -537,7 +537,7 @@ attributes:
   attribute is provided then no stop-words are loaded from files, unless an
   explicit `stopwordsPat` is also provided.
 
-  Note that if the `stopwordsPath` can not be accessed, is missing language
+  Note that if the `stopwordsPath` cannot be accessed, is missing language
   sub-directories or has no files for a language required by an Analyzer,
   then the creation of a new Analyzer is refused. If such an issue is 
   discovered for an existing Analyzer during startup then the server will
@@ -1077,7 +1077,7 @@ attributes:
 - `analyzer` (object, _required_): an Analyzer definition-like objects with
   `type` and `properties` attributes
 - `numHashes` (number, _required_): the size of the MinHash signature. Must be
-  greater or equal to `1`. The signature size defines the probalistic error
+  greater or equal to `1`. The signature size defines the probabilistic error
   (`err = rsqrt(numHashes)`). For an error amount that does not exceed 5%
   (`0.05`), use a size of `1 / (0.05 * 0.05) = 400`.
 
@@ -1426,7 +1426,7 @@ Built-in Analyzers
 ------------------
 
 There is a set of built-in Analyzers which are available by default for
-convenience and backward compatibility. They can not be removed.
+convenience and backward compatibility. They cannot be removed.
 
 The `identity` Analyzer has no properties and the `frequency` and `norm`
 features. The Analyzers of type `text` all tokenize strings with stemming

3.10/appendix-deprecated.md

@@ -162,7 +162,7 @@ replace the old features with:
     special HTTP headers `x-http-method`, `x-method-override` or 
     `x-http-method-override`. This was originally intended for very restricted
     callers, which only supported HTTP GET and HTTP POST, but seems very
-    unnecessary nowadways.
+    unnecessary nowadays.
   - `--http.hide-product-header`: whether or not to hide the `Server: ArangoDB`
     header in all responses served by arangod.
   - `--network.protocol`: network protocol to use for cluster-internal 

3.10/appendix-glossary.md

@@ -182,10 +182,12 @@ The fulltext index type is deprecated from version 3.10 onwards.
 A fulltext index can be used to find words, or prefixes of words inside documents. A fulltext index can be defined on one attribute only, and will include all words contained in documents that have a textual value in the index attribute. The index will also include words from the index attribute if the index attribute is an array of strings, or an object with string value members.
 
 For example, given a fulltext index on the `translations` attribute and the following documents, then searching for `лиса` using the fulltext index would return only the first document. Searching for the index for the exact string `Fox` would return the first two documents, and searching for `prefix:Fox` would return all three documents:
-     
-    { translations: { en: "fox", de: "Fuchs", fr: "renard", ru: "лиса" } }
-    { translations: "Fox is the English translation of the German word Fuchs" }
-    { translations: [ "ArangoDB", "document", "database", "Foxx" ] }
+
+```json
+{ "translations": { "en": "fox", "de": "Fuchs", "fr": "renard", "ru": "лиса" } }
+{ "translations": "Fox is the English translation of the German word Fuchs" }
+{ "translations": [ "ArangoDB", "document", "database", "Foxx" ] }
+```
 
 If the index attribute is neither a string, an object or an array, its contents will not be indexed. When indexing the contents of an array attribute, an array member will only be included in the index if it is a string. When indexing the contents of an object attribute, an object member value will only be included in the index if it is a string. Other data types are ignored and not indexed.
 

3.10/appendix-java-script-modules-actions.md

@@ -44,11 +44,11 @@ If *false*, then only use the action for exact matches. The default is
 `options.callback(request, response)`
 
 The request argument contains a description of the request. A request
-parameter *foo* is accessible as *request.parametrs.foo*. A request
+parameter *foo* is accessible as *request.parameters.foo*. A request
 header *bar* is accessible as *request.headers.bar*. Assume that
 the action is defined for the url */foo/bar* and the request url is
 */foo/bar/hugo/egon*. Then the suffix parts *[ "hugo", "egon" ]*
-are availible in *request.suffix*.
+are available in *request.suffix*.
 
 The callback must define fill the *response*.
 

3.10/appendix-java-script-modules-arango-db.md

@@ -13,7 +13,7 @@ This module should not be confused with the
 [`arangojs` JavaScript driver](https://github.com/arangodb/arangojs){:target="_blank"}
 which can be used to access ArangoDB from outside the database. Although the
 APIs share similarities and the functionality overlaps, the two are not
-compatible with each other and can not be used interchangeably.
+compatible with each other and cannot be used interchangeably.
 {% endhint %}
 
 The `db` object

3.10/appendix-java-script-modules-crypto.md

@@ -60,7 +60,7 @@ Returns the generated number.
 
 `crypto.genRandomAlphaNumbers(length): string`
 
-Generates a string of random alpabetical characters and digits.
+Generates a string of random alphabetical characters and digits.
 
 **Arguments**
 
@@ -172,7 +172,7 @@ Returns the JSON Web Token.
 * **noVerify**: `boolean` (Default: `false`)
 
   Whether verification should be skipped. If this is set to `true` the signature of the token will not be verified.
-  Otherwise the function will raise an error if the signature can not be verified using the given key.
+  Otherwise the function will raise an error if the signature cannot be verified using the given key.
 
 Returns the decoded JSON message or `null` if no token is provided.
 

3.10/appendix-references.md

@@ -1,6 +1,6 @@
 ---
 layout: default
-description: This section contains the documentation for some of the API's which are common on thearango shell, arangod server and for Foxx Apps
+description: This section contains the documentation for some of the API's which are common on the arango shell, arangod server and for Foxx Apps
 ---
 References
 ==========

3.10/aql/advanced.md

@@ -1,6 +1,6 @@
 ---
 layout: default
-description: This section covers additional, powerful AQL features, which you may wanna lookinto once you made yourself familiar with the basics of the query language
+description: This section covers additional, powerful AQL features, which you may wanna look into once you made yourself familiar with the basics of the query language
 ---
 Advanced features
 =================

3.10/aql/examples-remove-vertex.md

@@ -1,6 +1,6 @@
 ---
 layout: default
-description: Deleting vertices with associated edges is currently not handled via AQL while the graph management interfaceand theREST API for the graph moduleoffer a vertex deletion functionality
+description: Deleting vertices with associated edges is currently not handled via AQL while the graph management interface and the REST API for the graph module offer a vertex deletion functionality
 ---
 Remove Vertex
 =============

3.10/aql/execution-and-performance-optimizer.md

@@ -687,7 +687,7 @@ The following optimizer rules may appear in the `rules` attribute of
   for queries that only involve collection(s) with a single shard (and identical
   sharding in case of multiple collections, e.g. via `distributeShardsLike`).
   Queries involving V8 / JavaScript (e.g. user-defined AQL functions) or
-  SmartGraphs can not be optimized.
+  SmartGraphs cannot be optimized.
 
   Offloads the entire query to the DB-Server (except the client communication
   via a Coordinator). This saves all the back and forth that normally exists

3.10/aql/execution-and-performance-query-profiler.md

@@ -97,7 +97,7 @@ db.acollection.ensureIndex({type:"persistent", fields:["value"]});
 {% include arangoshexample.html id=examplevar script=script result=result %}
 
 This results in replacing the collection scan and filter block with an
-`IndexNode`. The execution pipeleine of the AQL query has become much shorter.
+`IndexNode`. The execution pipeline of the AQL query has become much shorter.
 Also the number of rows processed by each pipeline block is only 10, because
 we no longer need to look at all documents.
 

3.10/aql/functions-arangosearch.md

@@ -139,7 +139,7 @@ FOR doc IN viewName
   RETURN doc
 ```
 
-Despite the wrapping `ANALYZER()` function, the Analyzer name can not be
+Despite the wrapping `ANALYZER()` function, the Analyzer name cannot be
 omitted in calls to the `TOKENS()` function. Both occurrences of `text_en`
 are required, to set the Analyzer for the expression `doc.text IN ...` and
 for the `TOKENS()` function itself. This is because the `TOKENS()` function
@@ -469,11 +469,11 @@ calculation:
 
 ```aql
 LET target = "the quick brown fox jumps over the lazy dog"
-LET targetSingature = TOKENS(target, "myMinHash")
+LET targetSignature = TOKENS(target, "myMinHash")
 
 FOR doc IN viewName
   SEARCH MINHASH_MATCH(doc.text, target, 0.5, "myMinHash") // approximation
-  LET jaccard = JACCARD(targetSingature, TOKENS(doc.text, "myMinHash"))
+  LET jaccard = JACCARD(targetSignature, TOKENS(doc.text, "myMinHash"))
   FILTER jaccard > 0.75
   SORT jaccard DESC
   RETURN doc.text

3.10/aql/functions-document.md

@@ -108,14 +108,14 @@ HAS( { name: null }, "name" ) // true
 HAS( { }, "name" )            // false
 ```
 
-Note that `HAS()` can not utilize indexes. If it is not necessary to distinguish
+Note that `HAS()` cannot utilize indexes. If it is not necessary to distinguish
 between explicit and implicit *null* values in your query, you may use an equality
 comparison to test for *null* and create a non-sparse index on the attribute you
 want to test against:
 
 ```aql
-FILTER !HAS(doc, "name")    // can not use indexes
-FILTER IS_NULL(doc, "name") // can not use indexes
+FILTER !HAS(doc, "name")    // cannot use indexes
+FILTER IS_NULL(doc, "name") // cannot use indexes
 FILTER doc.name == null     // can utilize non-sparse indexes
 ```
 
@@ -450,7 +450,7 @@ documents accidentally. For example, the [arangojs](../drivers/js.html) driver
 skips attributes with a value of `undefined`, turning `{attr: undefined}` into `{}`.
 
 {% hint 'info' %}
-`MATCHES()` can not utilize indexes. You may use plain `FILTER` conditions instead
+`MATCHES()` cannot utilize indexes. You may use plain `FILTER` conditions instead
 to potentially benefit from existing indexes:
 
 ```aql

3.10/aql/functions-fulltext.md

@@ -1,6 +1,6 @@
 ---
 layout: default
-description: AQL offers the following functions to filter data based onfulltext indexes
+description: AQL offers the following functions to filter data based on fulltext indexes
 ---
 Fulltext functions
 ==================

3.10/aql/functions-geo.md

@@ -1,6 +1,6 @@
 ---
 layout: default
-description: The following helper functions can use geo indexes, but do not have to inall cases
+description: The following helper functions can use geo indexes, but do not have to in all cases
 ---
 Geo functions
 =============

3.10/aql/functions-miscellaneous.md

@@ -613,7 +613,7 @@ to `false`, then nothing will match. If *low* is greater than *high* nothing wil
 match either.
 
 {% hint 'info' %}
-The regular `IN_RANGE()` function can not utilize indexes, unlike its
+The regular `IN_RANGE()` function cannot utilize indexes, unlike its
 ArangoSearch counterpart which can use the View index.
 {% endhint %}
 

3.10/aql/fundamentals-syntax.md

@@ -23,9 +23,9 @@ not allowed.
 Whitespace
 ----------
 
-Whitespaces (blanks, carriage returns, line feeds, and tab stops) can be used
+Whitespace (blanks, carriage returns, line feeds, and tab stops) can be used
 in the query text to increase its readability. Tokens have to be separated by
-any number of whitespaces. Whitespace within strings or names must be enclosed
+any number of whitespace. Whitespace within strings or names must be enclosed
 in quotes in order to be preserved.
 
 Comments