Skip to content
This repository was archived by the owner on Dec 13, 2023. It is now read-only.

Commit fcad61c

Browse files
committed
Fix links
1 parent 7423249 commit fcad61c

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

42 files changed

+72
-60
lines changed

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ The request function takes the following options:
6666
* *json*: if `true`, *body* will be serialized to a JSON string and the *Content-Type* header will be set to `"application/json"`. Additionally the response body will also be parsed as JSON (unless *encoding* is set to `null`). Default: `false`.
6767
* *form* (optional): when set to a string or object and no *body* has been set, *body* will be set to a querystring representation of that value and the *Content-Type* header will be set to `"application/x-www-form-urlencoded"`. Also see *useQuerystring*.
6868
* *auth* (optional): an object with the properties *username* and *password* for HTTP Basic authentication or the property *bearer* for HTTP Bearer token authentication.
69-
* *sslProtocol* (optional): which tls version should be used to connect to the url. The default is `4` which is TLS 1.0. See [SSL protocol](programs-arangod-ssl.html#ssl-protocol) for more opitions.
69+
* *sslProtocol* (optional): which tls version should be used to connect to the url. The default is `4` which is TLS 1.0. See [SSL protocol](programs-arangod-options.html#--sslprotocol) for more options.
7070
* *followRedirect*: whether HTTP 3xx redirects should be followed. Default: `true`.
7171
* *maxRedirects*: the maximum number of redirects to follow. Default: `10`.
7272
* *encoding*: encoding to be used for the response body. If set to `null`, the response body will be returned as a `Buffer`. Default: `"utf-8"`.

3.10/aql/common-errors.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -410,7 +410,7 @@ FOR name IN Names
410410
You can set the startup option `--query.allow-collections-in-expressions` to
411411
*false* to disallow collection names in arbitrary places in AQL expressions
412412
to prevent such mistakes. Also see
413-
[ArangoDB Server Query Options](../programs-arangod-query.html#allowing-the-usage-of-collection-names-in-aql-expressions)
413+
[ArangoDB Server Query Options](../programs-arangod-options.html#--queryallow-collections-in-expressions)
414414

415415
{%- comment %}
416416
Rename to Error Sources?

3.10/aql/extending.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -57,9 +57,9 @@ of these resources, your query may abort with a
5757
[**cluster backend unavailable**](../appendix-error-codes.html) error.
5858

5959
To overcome these mentioned limitations, you may want to increase the
60-
[number of available V8 contexts](../programs-arangod-javascript.html#v8-contexts)
60+
[number of available V8 contexts](../programs-arangod-options.html#--javascriptv8-contexts)
6161
(at the expense of increased memory usage), and the
62-
[number of available server threads](../programs-arangod-server.html#server-threads).
62+
[number of available server threads](../programs-arangod-options.html#--serverthreads).
6363

6464
In addition, modification of global JavaScript variables from inside UDFs is
6565
unsupported, as is reading or changing the data of any collection or running

3.10/aql/fundamentals-type-value-order.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ result is defined as follows:
7878
- boolean: *false* is less than *true*
7979
- number: numeric values are ordered by their cardinal value
8080
- string: string values are ordered using a localized comparison, using the configured
81-
[server language](../programs-arangod-general.html#default-language)
81+
[server language](../programs-arangod-options.html#--defaultlanguage)
8282
for sorting according to the alphabetical order rules of that language
8383

8484
Note: unlike in SQL, *null* can be compared to any value, including *null*

3.10/aql/invocation-with-arangosh.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -270,7 +270,7 @@ the entire query result in RAM, a streaming query should be used.
270270
(i.e. `FOR i IN 1..100`), each row is one of such temporary values.
271271
This parameter is experimental and is only taken into account if a path for a
272272
directory to store the temporary data is provided with the
273-
[`--temp.intermediate-results-path` startup option](../programs-arangod-query.html#aql-query-with-spilling-input-data-to-disk).
273+
[`--temp.intermediate-results-path` startup option](../programs-arangod-options.html#--tempintermediate-results-path).
274274
Default value: `5000000` rows.
275275

276276
- `spillOverThresholdMemoryUsage`: This parameter allows for input data and
@@ -279,7 +279,7 @@ the entire query result in RAM, a streaming query should be used.
279279
is used for decreasing the memory usage during the query execution. This
280280
parameter is experimental and is only taken into account if a path for a
281281
directory to store the temporary data is provided with the
282-
[`--temp.intermediate-results-path` startup option](../programs-arangod-query.html#aql-query-with-spilling-input-data-to-disk).
282+
[`--temp.intermediate-results-path` startup option](../programs-arangod-options.html#--tempintermediate-results-path).
283283
Default value: 128MB.
284284

285285
## With `db._createStatement()` (ArangoStatement)

3.10/aql/operations-with.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ vertex collections as part of graph traversals.
4848

4949
You can enable the `--query.require-with` startup option to make single server
5050
instances require `WITH` declarations like cluster deployments to ease development,
51-
see [Requiring `WITH` statements](../programs-arangod-query.html#requiring-with-statements).
51+
see [Requiring `WITH` statements](../programs-arangod-options.html#--queryrequire-with).
5252

5353
Dynamic access via the `DOCUMENT()` function does not require you to list the
5454
involved collections. Using named graphs in traversals (`GRAPH "graph-name"`)

3.10/arangosearch-views.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -257,7 +257,7 @@ is used by these writers (in terms of "writers pool") one can use
257257
Maximum memory byte size per writer (segment) before a writer (segment) flush is
258258
triggered. `0` value turns off this limit for any writer (buffer) and data will
259259
be flushed periodically based on the
260-
[value defined for the flush thread](programs-arangod-server.html#data-source-flush-synchronization)
260+
[value defined for the flush thread](programs-arangod-options.html#--serverflush-interval)
261261
(ArangoDB server startup option). `0` value should be used carefully due to high
262262
potential memory consumption.
263263

3.10/architecture-storage-engines.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -53,11 +53,11 @@ The entire user transaction will not necessarily have ACID properties in this ca
5353
The threshold values for transaction sizes can be configured globally using the
5454
startup options
5555

56-
- [`--rocksdb.intermediate-commit-size`](programs-arangod-rocksdb.html#non-pass-through-options)
56+
- [`--rocksdb.intermediate-commit-size`](programs-arangod-options.html#--rocksdbintermediate-commit-size)
5757

58-
- [`--rocksdb.intermediate-commit-count`](programs-arangod-rocksdb.html#non-pass-through-options)
58+
- [`--rocksdb.intermediate-commit-count`](programs-arangod-options.html#--rocksdbintermediate-commit-count)
5959

60-
- [`--rocksdb.max-transaction-size`](programs-arangod-rocksdb.html#non-pass-through-options)
60+
- [`--rocksdb.max-transaction-size`](programs-arangod-options.html#--rocksdbmax-transaction-size)
6161

6262
It is also possible to override these thresholds per transaction.
6363

3.10/deployment-production-checklist.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ ArangoDB
3535
machine, adjust the [`ARANGODB_OVERRIDE_DETECTED_TOTAL_MEMORY`](programs-arangod-env-vars.html)
3636
environment variable accordingly.
3737
- For versions prior to 3.8, make sure to change the
38-
[`--query.memory-limit`](programs-arangod-query.html#limiting-memory-usage-of-aql-queries)
38+
[`--query.memory-limit`](programs-arangod-options.html#--querymemory-limit)
3939
query option according to the node size and workload.
4040
- Disable swap space to avoid slowdown which can result in servers being incorrectly
4141
detected as failed.

3.10/features-enterprise-edition.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -108,4 +108,4 @@ features outlined below. For additional information, see
108108
- **Advanced Encryption and Security Configuration**:
109109
Key rotation for [JWT secrets](http/general.html#hot-reload-of-jwt-secrets)
110110
and [on-disk encryption](http/administration-and-monitoring.html#encryption-at-rest),
111-
as well as [Server Name Indication (SNI)](programs-arangod-ssl.html#server-name-indication-sni).
111+
as well as [Server Name Indication (SNI)](programs-arangod-options.html#--sslserver-name-indication).

3.10/http/general.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -150,7 +150,7 @@ in client requests. ArangoDB supports authentication via HTTP Basic or JWT.
150150
Authentication is turned on by default for all internal database APIs but
151151
turned off for custom Foxx apps. To toggle authentication for incoming
152152
requests to the internal database APIs, use the option
153-
[--server.authentication](../programs-arangod-server.html#enabledisable-authentication).
153+
[--server.authentication](../programs-arangod-options.html#--serverauthentication).
154154
This option is turned on by default so authentication is required for the
155155
database APIs.
156156

@@ -161,7 +161,7 @@ requests (see [Cross Origin Resource Sharing requests](#cross-origin-resource-sh
161161
The response to an HTTP OPTIONS request will be generic and not expose any private data.
162162

163163
There is an additional option to control authentication for custom Foxx apps. The option
164-
[--server.authentication-system-only](../programs-arangod-server.html#enabledisable-authentication-for-system-api-requests-only)
164+
[--server.authentication-system-only](../programs-arangod-options.html#--serverauthentication-system-only)
165165
controls whether authentication is required only for requests to the internal
166166
database APIs and the admin interface. It is turned on by default, meaning that
167167
other APIs (this includes custom Foxx apps) do not require authentication.

3.10/indexing-persistent.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -303,7 +303,7 @@ will match.
303303
## Persistent Indexes and Server Language
304304

305305
The order of index entries in persistent indexes adheres to the configured
306-
[server language](programs-arangod-general.html#default-language).
306+
[server language](programs-arangod-options.html#--defaultlanguage).
307307
If, however, the server is restarted with a different language setting as when
308308
the persistent index was created, not all documents may be returned anymore and
309309
the sort order of those which are returned can be wrong (whenever the persistent

3.10/installation-linux-osconfiguration.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ sudo locale-gen "en_US.UTF-8"
3232
Your distribution may also provide a frontend for doing so, for instance
3333
[`dpkg-reconfigure locales` on Debian](https://wiki.debian.org/Locale){:target="_blank"}.
3434

35-
If you don't set a [default language](programs-arangod-general.html#default-language)
35+
If you don't set a [default language](programs-arangod-options.html#--defaultlanguage)
3636
for the server explicitly, ArangoDB will use the default locale of your system.
3737

3838
{% hint 'warning' %}

3.10/release-notes-new-features310.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1043,7 +1043,7 @@ arangod --temp.intermediate-results-path "tempDir"
10431043
--temp.intermediate-results-spillover-threshold-memory-usage 134217728
10441044
```
10451045

1046-
For more information, refer to the [Query invocation](aql/invocation-with-arangosh.html#additional-parameters-for-spilling-data-from-the-query-onto-disk) and [Query options](programs-arangod-query.html#aql-query-with-spilling-input-data-to-disk) topics.
1046+
For more information, refer to the [Query invocation](aql/invocation-with-arangosh.html#additional-parameters-for-spilling-data-from-the-query-onto-disk) and [Query options](programs-arangod-options.html#--tempintermediate-results-path) topics.
10471047

10481048
## Internal changes
10491049

3.10/release-notes-new-features36.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -658,13 +658,13 @@ Startup options
658658

659659
### Metrics API option
660660

661-
The new [option](programs-arangod-server.html#metrics-api)
661+
The new [option](programs-arangod-options.html#--servermetrics-api)
662662
`--server.export-metrics-api` allows you to disable the metrics API by setting
663663
it to `false`, which is otherwise turned on by default.
664664

665665
### OneShard cluster option
666666

667-
The [option](programs-arangod-cluster.html#more-advanced-options)
667+
The [option](programs-arangod-options.html#--clusterforce-one-shard)
668668
`--cluster.force-one-shard` enables the new OneShard feature for the entire
669669
cluster deployment. It forces the cluster into creating all future collections
670670
with only a single shard and using the same DB-Server as these collections'
@@ -674,7 +674,7 @@ transactional guarantees.
674674

675675
### Cluster upgrade option
676676

677-
The new [option](programs-arangod-cluster.html#upgrade) `--cluster.upgrade`
677+
The new [option](programs-arangod-options.html#--clusterupgrade) `--cluster.upgrade`
678678
toggles the cluster upgrade mode for Coordinators. It supports the following
679679
values:
680680

@@ -765,7 +765,7 @@ For example, to turn off the rule `use-indexes-for-sort`, use
765765

766766
--query.optimizer-rules "-use-indexes-for-sort"
767767

768-
The purpose of this [startup option](programs-arangod-query.html#optimizer-rule-defaults)
768+
The purpose of this [startup option](programs-arangod-options.html#--queryoptimizer-rules)
769769
is to be able to enable potential future experimental optimizer rules, which
770770
may be shipped in a disabled-by-default state.
771771

@@ -791,7 +791,7 @@ Hot Backup
791791
TLS v1.3
792792
--------
793793

794-
Added support for TLS 1.3 for the [arangod server](programs-arangod-ssl.html#ssl-protocol)
794+
Added support for TLS 1.3 for the [arangod server](programs-arangod-options.html#--sslprotocol)
795795
and the client tools (also added to v3.5.1).
796796

797797
The arangod server can be started with option `--ssl.protocol 6` to make it require

3.10/release-notes-new-features37.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -566,7 +566,7 @@ See: [HTTP Switching Protocols](http/general.html#switching-protocols)
566566

567567
Sometimes it is desirable to have the same server use different server keys
568568
and certificates when it is contacted under different names. This is possible
569-
with the [Server Name Indication](programs-arangod-ssl.html#server-name-indication-sni)
569+
with the [Server Name Indication](programs-arangod-options.html#--sslserver-name-indication)
570570
(SNI) TLS extension. It is now supported by ArangoDB using a new startup option
571571
`--ssl.server-name-indication`.
572572

3.10/transactions-stream-transactions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ connections were interrupted.
6767
A given transaction is intended to be used **serially**. No concurrent requests
6868
using the same transaction ID should be issued by the client. The server can
6969
make some effort to serialize certain operations (see
70-
[Streaming Lock Timeout](programs-arangod-transaction.html#streaming-lock-timeout)),
70+
[Streaming Lock Timeout](programs-arangod-options.html#--transactionstreaming-lock-timeout)),
7171
however, this degrades the server's performance and may lead to sporadic
7272
errors with code `28` (locked).
7373

3.10/tutorials-reduce-memory-footprint.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -174,7 +174,7 @@ Statistics
174174
----------
175175

176176
The server collects
177-
[statistics](programs-arangod-server.html#toggling-server-statistics) regularly,
177+
[statistics](programs-arangod-options.html#--serverstatistics) regularly,
178178
which is displayed in the web interface. You will have a light query load every
179179
few seconds, even if your application is idle, because of the statistics. If required, you can
180180
turn it off via:
@@ -272,7 +272,7 @@ The default for this option is 4, which means that a Coordinator with `t`
272272
scheduler threads can execute up to `4 * t` requests concurrently. The
273273
minimal value for this option is 1.
274274

275-
Also see [Preventing cluster overwhelm](programs-arangod-server.html#preventing-cluster-overwhelm).
275+
Also see the [_arangod_ startup options](programs-arangod-options.html#--serverongoing-low-priority-multiplier).
276276

277277
CPU usage
278278
---------

3.10/upgrading-manually-active-failover.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ Preparations
2020

2121
The ArangoDB installation packages (e.g. for Debian or Ubuntu) set up a
2222
convenient standalone instance of `arangod`. During installation, this instance's
23-
database will be upgraded (see [`--database.auto-upgrade`](programs-arangod-database.html#auto-upgrade))
23+
database will be upgraded (see [`--database.auto-upgrade`](programs-arangod-options.html#--databaseauto-upgrade))
2424
and the service will be (re)started.
2525

2626
You have to make sure that your _Active Failover_ deployment is independent of this

3.10/upgrading-manually-cluster.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Preparations
1919

2020
The ArangoDB installation packages (e.g. for Debian or Ubuntu) set up a
2121
convenient standalone instance of `arangod`. During installation, this instance's
22-
database will be upgraded (see [`--database.auto-upgrade`](programs-arangod-database.html#auto-upgrade))
22+
database will be upgraded (see [`--database.auto-upgrade`](programs-arangod-options.html#--databaseauto-upgrade))
2323
and the service will be (re)started.
2424

2525
You have to make sure that your _cluster_ deployment is independent of this

3.11/appendix-java-script-modules-request.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ The request function takes the following options:
6666
* *json*: if `true`, *body* will be serialized to a JSON string and the *Content-Type* header will be set to `"application/json"`. Additionally the response body will also be parsed as JSON (unless *encoding* is set to `null`). Default: `false`.
6767
* *form* (optional): when set to a string or object and no *body* has been set, *body* will be set to a querystring representation of that value and the *Content-Type* header will be set to `"application/x-www-form-urlencoded"`. Also see *useQuerystring*.
6868
* *auth* (optional): an object with the properties *username* and *password* for HTTP Basic authentication or the property *bearer* for HTTP Bearer token authentication.
69-
* *sslProtocol* (optional): which tls version should be used to connect to the url. The default is `4` which is TLS 1.0. See [SSL protocol](programs-arangod-ssl.html#ssl-protocol) for more opitions.
69+
* *sslProtocol* (optional): which tls version should be used to connect to the url. The default is `4` which is TLS 1.0. See [SSL protocol](programs-arangod-options.html#--sslprotocol) for more options.
7070
* *followRedirect*: whether HTTP 3xx redirects should be followed. Default: `true`.
7171
* *maxRedirects*: the maximum number of redirects to follow. Default: `10`.
7272
* *encoding*: encoding to be used for the response body. If set to `null`, the response body will be returned as a `Buffer`. Default: `"utf-8"`.

3.11/aql/common-errors.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -410,7 +410,7 @@ FOR name IN Names
410410
You can set the startup option `--query.allow-collections-in-expressions` to
411411
*false* to disallow collection names in arbitrary places in AQL expressions
412412
to prevent such mistakes. Also see
413-
[ArangoDB Server Query Options](../programs-arangod-query.html#allowing-the-usage-of-collection-names-in-aql-expressions)
413+
[ArangoDB Server Query Options](../programs-arangod-options.html#--queryallow-collections-in-expressions)
414414

415415
{%- comment %}
416416
Rename to Error Sources?

3.11/aql/extending.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -57,9 +57,9 @@ of these resources, your query may abort with a
5757
[**cluster backend unavailable**](../appendix-error-codes.html) error.
5858

5959
To overcome these mentioned limitations, you may want to increase the
60-
[number of available V8 contexts](../programs-arangod-javascript.html#v8-contexts)
60+
[number of available V8 contexts](../programs-arangod-options.html#--javascriptv8-contexts)
6161
(at the expense of increased memory usage), and the
62-
[number of available server threads](../programs-arangod-server.html#server-threads).
62+
[number of available server threads](../programs-arangod-options.html#--serverthreads).
6363

6464
In addition, modification of global JavaScript variables from inside UDFs is
6565
unsupported, as is reading or changing the data of any collection or running

3.11/aql/fundamentals-type-value-order.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ result is defined as follows:
7878
- boolean: *false* is less than *true*
7979
- number: numeric values are ordered by their cardinal value
8080
- string: string values are ordered using a localized comparison, using the configured
81-
[server language](../programs-arangod-general.html#default-language)
81+
[server language](../programs-arangod-options.html#--defaultlanguage)
8282
for sorting according to the alphabetical order rules of that language
8383

8484
Note: unlike in SQL, *null* can be compared to any value, including *null*

3.11/aql/invocation-with-arangosh.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -270,7 +270,7 @@ the entire query result in RAM, a streaming query should be used.
270270
(i.e. `FOR i IN 1..100`), each row is one of such temporary values.
271271
This parameter is experimental and is only taken into account if a path for a
272272
directory to store the temporary data is provided with the
273-
[`--temp.intermediate-results-path` startup option](../programs-arangod-query.html#aql-query-with-spilling-input-data-to-disk).
273+
[`--temp.intermediate-results-path` startup option](../programs-arangod-options.html#--tempintermediate-results-path).
274274
Default value: `5000000` rows.
275275

276276
- `spillOverThresholdMemoryUsage`: This parameter allows for input data and
@@ -279,7 +279,7 @@ the entire query result in RAM, a streaming query should be used.
279279
is used for decreasing the memory usage during the query execution. This
280280
parameter is experimental and is only taken into account if a path for a
281281
directory to store the temporary data is provided with the
282-
[`--temp.intermediate-results-path` startup option](../programs-arangod-query.html#aql-query-with-spilling-input-data-to-disk).
282+
[`--temp.intermediate-results-path` startup option](../programs-arangod-options.html#--tempintermediate-results-path).
283283
Default value: 128MB.
284284

285285
## With `db._createStatement()` (ArangoStatement)

0 commit comments

Comments
 (0)