Skip to content

Commit 978a258

Browse files
authored
Merge pull request #2079 from Lwiel/new-docs2
RDoc-3361 Fixed more links
2 parents 03fc18c + dcd4b88 commit 978a258

File tree

108 files changed

+389
-389
lines changed

Some content is hidden

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

108 files changed

+389
-389
lines changed

cloud/cloud-instances.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ to create a **free**-tier instance.
6262
A development server is equipped with all of RavenDB's [features](https://ravendb.net/buy)
6363
but is **not** suitable for production for the following reasons:
6464

65-
* A single-node configuration (no [replication](../7.1/server/clustering/replication/replication)).
65+
* A single-node configuration (no [replication](../7.1/server/clustering/replication/replication-overview)).
6666
* [Burstable](../cloud/cloud-overview.mdx#burstable-instances) CPU usage, suitable for small to medium production loads.
6767
Burstable instances can become throttled if usage exceeds allocated resources.
6868
* Lack of [backup](../cloud/cloud-backup-and-restore.mdx#cloud-backup) procedure.

docs/ai-integration/generating-embeddings/overview.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -124,10 +124,10 @@ import LanguageContent from "@site/src/components/LanguageContent";
124124
where you can track processing duration, batch sizes, and overall progress.
125125
Learn more about the functionality of the stats view in the [Ongoing Tasks Stats](../../studio/database/stats/ongoing-tasks-stats/overview.mdx) article.
126126

127-
* The number of embeddings generation tasks across all databases can also be monitored using [SNMP](../../server/administration/snmp/snmp.mdx).
127+
* The number of embeddings generation tasks across all databases can also be monitored using [SNMP](../../server/administration/snmp/snmp-overview.mdx).
128128
The following SNMP OIDs provide relevant metrics:
129-
* [5.1.11.25](../../server/administration/snmp/snmp.mdx#5.1.11.25) – Total number of enabled embeddings generation tasks.
130-
* [5.1.11.26](../../server/administration/snmp/snmp.mdx#5.1.11.26) – Total number of active embeddings generation tasks.
129+
* [5.1.11.25](../../server/administration/snmp/snmp-overview.mdx#5.1.11.25) – Total number of enabled embeddings generation tasks.
130+
* [5.1.11.26](../../server/administration/snmp/snmp-overview.mdx#5.1.11.26) – Total number of active embeddings generation tasks.
131131

132132

133133

docs/client-api/faq/transaction-support.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -121,7 +121,7 @@ then you must enable [optimistic concurrency](../../client-api/session/configura
121121
### Multi-master model
122122

123123
RavenDB employs the multi-master model, allowing writes to be made to any node in the cluster.
124-
These writes are then propagated asynchronously to the other nodes via [replication](../../server/clustering/replication/replication.mdx).
124+
These writes are then propagated asynchronously to the other nodes via [replication](../../server/clustering/replication/replication-overview.mdx).
125125

126126
The interaction of transactions and distributed work is anything but trivial. Let's start from the obvious problem:
127127

@@ -174,11 +174,11 @@ If you care about avoiding lost updates, you need to ensure you have the conflic
174174

175175
The following is an important aspect to RavenDB's transactional behavior with regards to asynchronous replication.
176176

177-
When replicating modifications to another server, RavenDB will ensure that the [transaction boundaries](../../server/clustering/replication/replication.mdx#replication-&-transaction-boundary) are maintained.
177+
When replicating modifications to another server, RavenDB will ensure that the [transaction boundaries](../../server/clustering/replication/replication-overview.mdx#replication-&-transaction-boundary) are maintained.
178178
If there are several document modifications in the same transaction they will be sent in the same replication batch, keeping the transaction boundary on the destination as well.
179179

180180
However, a special attention is needed when a document is modified in two separate transactions but the replication of the first transaction has not occurred yet.
181-
Read more about that in [How revisions replication help data consistency](../../server/clustering/replication/replication.mdx#how-revisions-replication-help-data-consistency).
181+
Read more about that in [How revisions replication help data consistency](../../server/clustering/replication/replication-overview.mdx#how-revisions-replication-help-data-consistency).
182182

183183
<hr/>
184184

docs/client-api/operations/maintenance/backup/backup-overview.mdx

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -20,26 +20,26 @@ import LanguageContent from "@site/src/components/LanguageContent";
2020
* RavenDB's Backup task is an [Ongoing-Task](../../../../studio/database/tasks/ongoing-tasks/general-info.mdx)
2121
designed to run periodically on a pre-defined schedule.
2222
You can run it as a one-time operation as well, by using [Export](../../../../client-api/smuggler/what-is-smuggler.mdx#export)
23-
or executing a backup task [immediately](../../../../client-api/operations/maintenance/backup/backup.mdx#initiate-immediate-backup-execution).
23+
or executing a backup task [immediately](../../../../client-api/operations/maintenance/backup/backup-overview.mdx#initiate-immediate-backup-execution).
2424

2525
* On a [sharded](../../../../sharding/overview.mdx) database, a single backup task
2626
is defined by the user for all shards, and RavenDB automatically defines
2727
sub-tasks that create backups per shard.
2828
Read about backups on a sharded database [in the section dedicated to it](../../../../sharding/backup-and-restore/backup.mdx).
2929

3030
* In this page:
31-
* [Backup Types](../../../../client-api/operations/maintenance/backup/backup.mdx#backup-types)
32-
* [Logical-Backup](../../../../client-api/operations/maintenance/backup/backup.mdx#logical-backup)
33-
* [Snapshot](../../../../client-api/operations/maintenance/backup/backup.mdx#snapshot)
34-
* [Backup Scope](../../../../client-api/operations/maintenance/backup/backup.mdx#backup-scope)
35-
* [Full Backup](../../../../client-api/operations/maintenance/backup/backup.mdx#full-backup)
36-
* [Incremental Backup](../../../../client-api/operations/maintenance/backup/backup.mdx#incremental-backup)
37-
* [Backup to Local and Remote Destinations](../../../../client-api/operations/maintenance/backup/backup.mdx#backup-to-local-and-remote-destinations)
38-
* [Backup Retention Policy](../../../../client-api/operations/maintenance/backup/backup.mdx#backup-retention-policy)
39-
* [Server-Wide Backup](../../../../client-api/operations/maintenance/backup/backup.mdx#server-wide-backup)
40-
* [Initiate Immediate Backup Execution](../../../../client-api/operations/maintenance/backup/backup.mdx#initiate-immediate-backup-execution)
41-
* [Delay Backup Execution](../../../../client-api/operations/maintenance/backup/backup.mdx#delay-backup-execution)
42-
* [Recommended Precautions](../../../../client-api/operations/maintenance/backup/backup.mdx#recommended-precautions)
31+
* [Backup Types](../../../../client-api/operations/maintenance/backup/backup-overview.mdx#backup-types)
32+
* [Logical-Backup](../../../../client-api/operations/maintenance/backup/backup-overview.mdx#logical-backup)
33+
* [Snapshot](../../../../client-api/operations/maintenance/backup/backup-overview.mdx#snapshot)
34+
* [Backup Scope](../../../../client-api/operations/maintenance/backup/backup-overview.mdx#backup-scope)
35+
* [Full Backup](../../../../client-api/operations/maintenance/backup/backup-overview.mdx#full-backup)
36+
* [Incremental Backup](../../../../client-api/operations/maintenance/backup/backup-overview.mdx#incremental-backup)
37+
* [Backup to Local and Remote Destinations](../../../../client-api/operations/maintenance/backup/backup-overview.mdx#backup-to-local-and-remote-destinations)
38+
* [Backup Retention Policy](../../../../client-api/operations/maintenance/backup/backup-overview.mdx#backup-retention-policy)
39+
* [Server-Wide Backup](../../../../client-api/operations/maintenance/backup/backup-overview.mdx#server-wide-backup)
40+
* [Initiate Immediate Backup Execution](../../../../client-api/operations/maintenance/backup/backup-overview.mdx#initiate-immediate-backup-execution)
41+
* [Delay Backup Execution](../../../../client-api/operations/maintenance/backup/backup-overview.mdx#delay-backup-execution)
42+
* [Recommended Precautions](../../../../client-api/operations/maintenance/backup/backup-overview.mdx#recommended-precautions)
4343

4444
</Admonition>
4545
## Backup Types
@@ -111,7 +111,7 @@ var result = await docStore.Maintenance.SendAsync(operation);
111111
* If Incremental backups are created for a Snapshot-type backup:
112112
* The first backup will be a full Snapshot.
113113
* The following backups will be Incremental.
114-
* [Incremental backups](../../../../client-api/operations/maintenance/backup/backup.mdx#incremental-backup)
114+
* [Incremental backups](../../../../client-api/operations/maintenance/backup/backup-overview.mdx#incremental-backup)
115115
have different storage contents than Snapshots.
116116

117117
* Code Sample:
@@ -361,7 +361,7 @@ The retention policy is a property of `PeriodicBackupConfiguration`:
361361
You can create a Server-Wide Backup task to back-up **all the databases in your cluster** at a scheduled time.
362362
Individual databases can be excluded from the backup. Learn more in [Studio: Server-Wide Backup](../../../../studio/server/server-wide-backup.mdx).
363363

364-
Backups can be made locally, as well as to a [set of remote locations](../../../../client-api/operations/maintenance/backup/backup.mdx#backup-to-local-and-remote-destinations).
364+
Backups can be made locally, as well as to a [set of remote locations](../../../../client-api/operations/maintenance/backup/backup-overview.mdx#backup-to-local-and-remote-destinations).
365365

366366
#### Examples
367367

@@ -585,7 +585,7 @@ await docStore.Maintenance.SendAsync(
585585
* An ACIDity of backed-up data, to keep its independence during restoration.
586586

587587
* **Remove old backup files regularly**.
588-
Set the [backup retention policy](../../../../client-api/operations/maintenance/backup/backup.mdx#backup-retention-policy)
588+
Set the [backup retention policy](../../../../client-api/operations/maintenance/backup/backup-overview.mdx#backup-retention-policy)
589589
to remove unneeded backup files so that they don't build up.
590590
While setting how many days to keep your backups, consider how much of a recent database history you would like to have access to.
591591

docs/client-api/operations/maintenance/backup/encrypted-backup.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -104,17 +104,17 @@ Secure the data stored on the server by
104104
can be different than the original database encryption key.
105105

106106
* **Snapshot**
107-
A [snapshot](../../../../client-api/operations/maintenance/backup/backup.mdx#snapshot) is an exact image of your database.
107+
A [snapshot](../../../../client-api/operations/maintenance/backup/backup-overview.mdx#snapshot) is an exact image of your database.
108108
If the database is **not encrypted**, its snapshot wouldn't be either.
109109
If the database is **encrypted**, its snapshot would also be encrypted using the database encryption key.
110110
If you want your snapshot to be encrypted, simply take the snapshot of an
111111
[encrypted database](../../../../server/security/encryption/database-encryption.mdx#creating-an-encrypted-database-using-the-rest-api-and-the-client-api).
112112
#### Choosing Encryption Mode & Key
113113

114-
Use the same [Backup](../../../../client-api/operations/maintenance/backup/backup.mdx#backup) and [Restore](../../../../client-api/operations/maintenance/backup/restore.mdx) methods that are used to create and restore **un**-encrypted backups.
114+
Use the same [Backup](../../../../client-api/operations/maintenance/backup/backup-overview.mdx#backup) and [Restore](../../../../client-api/operations/maintenance/backup/restore.mdx) methods that are used to create and restore **un**-encrypted backups.
115115
Specify whether encryption is used, and with which encryption key,
116116
in the **BackupEncryptionSettings** structure defined within the
117-
[PeriodicBackupConfiguration](../../../../client-api/operations/maintenance/backup/backup.mdx#backup-to-local-and-remote-destinations) object.
117+
[PeriodicBackupConfiguration](../../../../client-api/operations/maintenance/backup/backup-overview.mdx#backup-to-local-and-remote-destinations) object.
118118

119119
* `BackupEncryptionSettings` definition:
120120
<TabItem value="BackupEncryptionSettings_definition" label="BackupEncryptionSettings_definition">

docs/client-api/operations/maintenance/backup/faq.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ time-signatures are consistent even when the backups are created by different no
6565
### Is an External Replication task a good substitute for a backup task?
6666

6767
Although [External Replication](../../../../studio/database/tasks/ongoing-tasks/external-replication-task.mdx)
68-
and [Backup](../../../../client-api/operations/maintenance/backup/backup.mdx)
68+
and [Backup](../../../../client-api/operations/maintenance/backup/backup-overview.mdx)
6969
are both ongoing tasks that create a copy of your data, they have different aims and behavior.
7070

7171
For example, replication tasks don't allow you to retrieve data from a history/restore point after mistakes,
@@ -74,7 +74,7 @@ See [Backup Task -vs- External Replication Task](../../../../studio/database/tas
7474
### Can I simply copy the database folder contents whenever I need to create a backup?
7575

7676
Simply copying the database folder of a live database will probably create corrupted data in the backup.
77-
Creating an [ongoing backup task](../../../../client-api/operations/maintenance/backup/backup.mdx) is a one-time operation.
77+
Creating an [ongoing backup task](../../../../client-api/operations/maintenance/backup/backup-overview.mdx) is a one-time operation.
7878
There really is no reason to do it manually again and again.
7979
There really is no reason to do it manually again and again. Properly backing up provides:
8080

@@ -88,7 +88,7 @@ If you enable it, RavenDB will delete backups after the `TimeSpan` that you set.
8888
By default, `RetentionPolicy` is disabled.
8989

9090
Learn how to change the [Retention Policy via the RavenDB Studio](../../../../studio/database/tasks/backup-task.mdx#retention-policy).
91-
Learn how to change the [Retention Policy via API](../../../../client-api/operations/maintenance/backup/backup.mdx#backup-retention-policy).
91+
Learn how to change the [Retention Policy via API](../../../../client-api/operations/maintenance/backup/backup-overview.mdx#backup-retention-policy).
9292
### Are there any locations that backup files should NOT be stored at?
9393

9494
It is recommended **not to store backups on the same drive as your database** data files,

docs/client-api/operations/maintenance/backup/restore.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -183,11 +183,11 @@ You can create the cluster in advance, and restore the database to multiple node
183183

184184
<Admonition type="note" title="This procedure is advisable only when restoring a Snapshot." id="this-procedure-is-advisable-only-when-restoring-a-snapshot" href="#this-procedure-is-advisable-only-when-restoring-a-snapshot">
185185

186-
* When a [logical-backup](../../../../client-api/operations/maintenance/backup/backup.mdx#logical-backup)
186+
* When a [logical-backup](../../../../client-api/operations/maintenance/backup/backup-overview.mdx#logical-backup)
187187
is restored, each document receives a new change-vector according to the node it resides on.
188188
When the database instances synchronize, this change-vector will be updated and be composed of all database nodes tags.
189189

190-
* When a [snapshot](../../../../client-api/operations/maintenance/backup/backup.mdx#snapshot) is restored,
190+
* When a [snapshot](../../../../client-api/operations/maintenance/backup/backup-overview.mdx#snapshot) is restored,
191191
documents are **not** assigned a new change-vector because the databases kept by all nodes are considered identical.
192192
Each document retains the original change-vector it had during backup.
193193
When the database instances synchronize, documents' change-vectors do **not** change.

docs/data-archival/archived-documents-and-other-features.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -548,8 +548,8 @@ loadToOrders(this);
548548

549549
## Archived documents and replication
550550

551-
Archived documents are included in [Internal](../server/clustering/replication/replication.mdx#internal-replication) replication,
552-
[External](../server/clustering/replication/replication.mdx#external-replication) replication, and [Hub/Sink](../server/clustering/replication/replication.mdx#hubsink-replication) replication -
551+
Archived documents are included in [Internal](../server/clustering/replication/replication-overview.mdx#internal-replication) replication,
552+
[External](../server/clustering/replication/replication-overview.mdx#external-replication) replication, and [Hub/Sink](../server/clustering/replication/replication-overview.mdx#hubsink-replication) replication -
553553
no special configuration is required.
554554

555555

docs/data-archival/overview.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ import LanguageContent from "@site/src/components/LanguageContent";
4949
* The server scans the database periodically (at an interval specified when the task is enabled),
5050
identifies documents scheduled for archiving, and archives them at the scheduled time.
5151
* In a cluster, the archiving task runs on the [preferred node](../client-api/configuration/load-balance/overview.mdx#the-preferred-node) (the first node in the cluster topology).
52-
Archived documents are then propagated to the other nodes through [internal replication](../server/clustering/replication/replication.mdx#internal-replication).
52+
Archived documents are then propagated to the other nodes through [internal replication](../server/clustering/replication/replication-overview.mdx#internal-replication).
5353

5454
* **What is archived**
5555
* The JSON document itself is archived.

docs/document-extensions/revisions/client-api/operations/delete-revisions.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ export const supportedLanguages = ["csharp"];
2828
even if these settings are disabled.
2929

3030
* When working with a secure server:
31-
* The delete revisions action will be logged in the [audit log](../../../../server/security/audit-log/audit-log.mdx).
31+
* The delete revisions action will be logged in the [audit log](../../../../server/security/audit-log/audit-log-overview.mdx).
3232
* This operation is only available for a client certificate with a [security clearance](../../../../server/security/authorization/security-clearance-and-permissions.mdx) of _DatabaseAdmin_ or higher.
3333

3434
* By default, the operation will be applied to the [default database](../../../../client-api/setting-up-default-database.mdx).

0 commit comments

Comments
 (0)