Skip to content

Commit 32c5bd8

Browse files
authored
Merge pull request #2077 from Lwiel/new-docs2
RDoc-3361 Updated links and codeblock labels
2 parents 022b1f8 + 9810130 commit 32c5bd8

File tree

1,825 files changed

+55411
-54659
lines changed

Some content is hidden

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

1,825 files changed

+55411
-54659
lines changed

cloud/cloud-api.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ RavenDB Cloud does not send reminders about upcoming API key expiration.
6262
</Admonition>
6363

6464
You can change the expiration date or extend it for another *12 months*.
65-
For more details, please check the [Edit API Key](../cloud/portal/cloud-portal-api-tab#edit-api-key) section.
65+
For more details, please check the [Edit API Key](../cloud/portal/cloud-portal-api-tab.mdx#edit-api-key) section.
6666

6767

6868

cloud/cloud-aws-marketplace.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,9 @@ import LanguageContent from "@site/src/components/LanguageContent";
1818
Access to *RavenDB Cloud* services is available through the *AWS Marketplace*.
1919

2020
* In this page:
21-
* [Overview](../cloud/cloud-aws-marketplace#overview)
22-
* [Registration process](../cloud/cloud-aws-marketplace#registration-process)
23-
* [Subscription cancellation process](../cloud/cloud-aws-marketplace#subscription-cancellation-process)
21+
* [Overview](../cloud/cloud-aws-marketplace.mdx#overview)
22+
* [Registration process](../cloud/cloud-aws-marketplace.mdx#registration-process)
23+
* [Subscription cancellation process](../cloud/cloud-aws-marketplace.mdx#subscription-cancellation-process)
2424

2525
</Admonition>
2626
## Overview

cloud/cloud-backup-and-restore.mdx

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -15,26 +15,26 @@ import LanguageContent from "@site/src/components/LanguageContent";
1515
# Cloud: Backup And Restore
1616
<Admonition type="note" title="Note">
1717

18-
* RavenDB cloud instances of the [Free](../cloud/cloud-instances#a-free-cloud-node) and
19-
[Production](../cloud/cloud-instances#a-production-cloud-cluster) tiers are regularly and automatically backed up.
18+
* RavenDB cloud instances of the [Free](../cloud/cloud-instances.mdx#a-free-cloud-node) and
19+
[Production](../cloud/cloud-instances.mdx#a-production-cloud-cluster) tiers are regularly and automatically backed up.
2020

2121
* You can also define custom backup tasks, as you would with an on-premises RavenDB server.
2222

23-
* [Development](../cloud/cloud-instances#a-development-cloud-server) products do **not** offer mandatory backup by RavenDB Cloud.
23+
* [Development](../cloud/cloud-instances.mdx#a-development-cloud-server) products do **not** offer mandatory backup by RavenDB Cloud.
2424
You **can** define custom backup tasks for them.
2525

2626
* In this page:
27-
* [The Mandatory-Backup Routine](../cloud/cloud-backup-and-restore#the-mandatory-backup-routine)
28-
* [Backup storage](../cloud/cloud-backup-and-restore#backup-storage)
29-
* [Charging For Backup storage](../cloud/cloud-backup-and-restore#charging-for-backup-storage)
30-
* [Backup Encryption](../cloud/cloud-backup-and-restore#backup-encryption)
31-
* [Creating a Custom Backup](../cloud/cloud-backup-and-restore#creating-a-custom-backup)
32-
* [Restore Mandatory-Backup Files](../cloud/cloud-backup-and-restore#restore-mandatory-backup-files)
27+
* [The Mandatory-Backup Routine](../cloud/cloud-backup-and-restore.mdx#the-mandatory-backup-routine)
28+
* [Backup storage](../cloud/cloud-backup-and-restore.mdx#backup-storage)
29+
* [Charging For Backup storage](../cloud/cloud-backup-and-restore.mdx#charging-for-backup-storage)
30+
* [Backup Encryption](../cloud/cloud-backup-and-restore.mdx#backup-encryption)
31+
* [Creating a Custom Backup](../cloud/cloud-backup-and-restore.mdx#creating-a-custom-backup)
32+
* [Restore Mandatory-Backup Files](../cloud/cloud-backup-and-restore.mdx#restore-mandatory-backup-files)
3333
</Admonition>
3434
## The Mandatory-Backup Routine
3535

3636
Each database you create using a RavenDB cloud product, is assigned a mandatory-backup task that
37-
stores a [full backup](../server/ongoing-tasks/backup-overview#backup-scope-full-or-incremental)
37+
stores a [full backup](../7.1/server/ongoing-tasks/backup-overview#backup-scope-full-or-incremental)
3838
**every 24 hours** and an **incremental backup every 1 hour** with all the changes that took
3939
place since the last backup.
4040

@@ -44,7 +44,7 @@ The mandatory backup process cannot be disabled.
4444

4545
<Admonition type="info" title="Info">
4646
We keep your backup files for no less than 14 days.
47-
You can [contact support](../cloud/portal/cloud-portal-support-tab) to prolong this period, but not reduce it.
47+
You can [contact support](../cloud/portal/cloud-portal-support-tab.mdx) to prolong this period, but not reduce it.
4848
</Admonition>
4949
#### The Backup Task
5050

@@ -60,9 +60,9 @@ To view or activate the mandatory backup task, open your product's management st
6060
## Backup storage
6161

6262
#### Mandatory-Backup Storage
63-
Backups created by the [mandatory backup routine](../cloud/cloud-backup-and-restore#the-mandatory-backup-routine) are stored in a RavenDB
63+
Backups created by the [mandatory backup routine](../cloud/cloud-backup-and-restore.mdx#the-mandatory-backup-routine) are stored in a RavenDB
6464
cloud you have no direct access to.
65-
You can [view and restore](../cloud/cloud-backup-and-restore#restore-mandatory-backup-files) them using your portal's Backups tab and the
65+
You can [view and restore](../cloud/cloud-backup-and-restore.mdx#restore-mandatory-backup-files) them using your portal's Backups tab and the
6666
management Studio.
6767

6868
<Admonition type="note" title="Note">
@@ -80,7 +80,7 @@ Upon backup geographically closest AWS S3 bucket is used for backup storage e.g.
8080
- if your RavenDB Cloud cluster has been created in the US, it backs up to AWS S3 buckets in the US.
8181
</Admonition>
8282
#### Custom-Backup Storage
83-
[Custom-backup](../cloud/cloud-backup-and-restore#creating-a-custom-backup) files can be kept using an Amazon service
83+
[Custom-backup](../cloud/cloud-backup-and-restore.mdx#creating-a-custom-backup) files can be kept using an Amazon service
8484
(S3 or S3 Glacier) or a Microsoft service (Azure).
8585
We recommend that you use a backup method **local to your host cloud**. If your product is hosted by Amazon AWS for example,
8686
you can store your backup files on an Amazon S3 bucket.

cloud/cloud-instances.mdx

Lines changed: 26 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -16,35 +16,35 @@ import LanguageContent from "@site/src/components/LanguageContent";
1616

1717
<Admonition type="note" title="Note">
1818

19-
- Use your portal's [Products tab](../cloud/portal/cloud-portal-products-tab) to raise or modify
19+
- Use your portal's [Products tab](../cloud/portal/cloud-portal-products-tab.mdx) to raise or modify
2020
a Free node, a Development node, or a Production cluster.
2121
- Free and Development nodes, as well as Production "basic" grade clusters, are operated by
22-
[burstable instances](../cloud/cloud-overview#burstable-vs.-reserved-clusters).
23-
- The Production cluster grades [Standard](../cloud/cloud-instances#standard-grade-production-cluster)
24-
and [Performance](../cloud/cloud-instances#performance-grade-production-cluster) are
25-
[Reserved clusters](../cloud/cloud-overview#burstable-vs.-reserved-clusters).
22+
[burstable instances](../cloud/cloud-overview.mdx#burstable-vs.-reserved-clusters).
23+
- The Production cluster grades [Standard](../cloud/cloud-instances.mdx#standard-grade-production-cluster)
24+
and [Performance](../cloud/cloud-instances.mdx#performance-grade-production-cluster) are
25+
[Reserved clusters](../cloud/cloud-overview.mdx#burstable-vs.-reserved-clusters).
2626

2727
In this page:
2828

29-
* [A Free Cloud Node](../cloud/cloud-instances#a-free-cloud-node)
30-
* [A Development Cloud Server](../cloud/cloud-instances#a-development-cloud-server)
31-
* [A Production Cloud Cluster](../cloud/cloud-instances#a-production-cloud-cluster)
32-
- [Basic-grade Production Cluster](../cloud/cloud-instances#basic-grade-production-cluster)
33-
- [Standard-grade Production Cluster](../cloud/cloud-instances#standard-grade-production-cluster)
34-
- [Performance-grade Production Cluster](../cloud/cloud-instances#performance-grade-production-cluster)
29+
* [A Free Cloud Node](../cloud/cloud-instances.mdx#a-free-cloud-node)
30+
* [A Development Cloud Server](../cloud/cloud-instances.mdx#a-development-cloud-server)
31+
* [A Production Cloud Cluster](../cloud/cloud-instances.mdx#a-production-cloud-cluster)
32+
- [Basic-grade Production Cluster](../cloud/cloud-instances.mdx#basic-grade-production-cluster)
33+
- [Standard-grade Production Cluster](../cloud/cloud-instances.mdx#standard-grade-production-cluster)
34+
- [Performance-grade Production Cluster](../cloud/cloud-instances.mdx#performance-grade-production-cluster)
3535
</Admonition>
3636
## A Free Cloud Node
3737

3838
Free RavenDB cloud nodes are great for experiments and evaluation. They are equipped with the
3939
most basic configuration and capabilities. They have a single node and no Service-Level Agreement (SLA).
40-
You can run only one free node per [account](../cloud/cloud-overview#your-account).
40+
You can run only one free node per [account](../cloud/cloud-overview.mdx#your-account).
4141

42-
To raise a free cloud node, use the [Products tab](../cloud/portal/cloud-portal-products-tab)
42+
To raise a free cloud node, use the [Products tab](../cloud/portal/cloud-portal-products-tab.mdx)
4343
to create a **free**-tier instance.
4444

4545
!["Tiers and Instances: Free"](./assets/tiers-and-instances-001-free.png)
4646

47-
* A free instance is identical to a development [Dev10](../cloud/cloud-instances#a-development-cloud-server) instance.
47+
* A free instance is identical to a development [Dev10](../cloud/cloud-instances.mdx#a-development-cloud-server) instance.
4848
It comes with a monthly credit of **$10**, used to cover the cost of the instance and incidentals like backup storage
4949
and traffic.
5050
<Admonition type="note" title="Note">
@@ -62,11 +62,11 @@ 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](../server/clustering/replication/replication)).
66-
* [Burstable](../cloud/cloud-overview#burstable-instances) CPU usage, suitable for small to medium production loads.
65+
* A single-node configuration (no [replication](../7.1/server/clustering/replication/replication)).
66+
* [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.
68-
* Lack of [backup](../cloud/cloud-backup-and-restore#cloud-backup) procedure.
69-
* No [Service Level Agreement](../cloud/portal/cloud-portal-support-tab#support-entitlement).
68+
* Lack of [backup](../cloud/cloud-backup-and-restore.mdx#cloud-backup) procedure.
69+
* No [Service Level Agreement](../cloud/portal/cloud-portal-support-tab.mdx#support-entitlement).
7070

7171
To raise a cloud Development server, create a product using the Products tab and select the **Development** tier.
7272

@@ -105,7 +105,7 @@ with a **higher number of nodes** to further distribute the cluster's workload.
105105
[Contact Support](https://ravendb.net/contact) to provision customized cloud-based clusters
106106
with configurations that suit your needs.
107107

108-
*Production tier* clusters can be also extended by [additional product nodes](../cloud/portal/cloud-portal-products-tab#nodes-additional-product-nodes).
108+
*Production tier* clusters can be also extended by [additional product nodes](../cloud/portal/cloud-portal-products-tab.mdx#nodes-additional-product-nodes).
109109
<Admonition type="info" title="Info">
110110
This option is not available for **PS** instance types.
111111
</Admonition>
@@ -120,20 +120,20 @@ Please be aware that cloud cluster nodes are provided with dynamic IP addresses
120120

121121
The production tier offers three instance levels:
122122

123-
1. [Basic](../cloud/cloud-instances#basic-grade-production-cluster)
124-
2. [Standard](../cloud/cloud-instances#standard-grade-production-cluster)
125-
3. [Performance](../cloud/cloud-instances#performance-grade-production-cluster)
123+
1. [Basic](../cloud/cloud-instances.mdx#basic-grade-production-cluster)
124+
2. [Standard](../cloud/cloud-instances.mdx#standard-grade-production-cluster)
125+
3. [Performance](../cloud/cloud-instances.mdx#performance-grade-production-cluster)
126126
#### 1. Basic-grade Production Cluster
127-
Basic production clusters are [burstable](../cloud/cloud-overview#burstable-instances).
127+
Basic production clusters are [burstable](../cloud/cloud-overview.mdx#burstable-instances).
128128
While suitable for low to medium workloads, they trade-off peak efficiency for lower costs.
129129

130130
<Admonition type="note" title="Throttling" id="throttling" href="#throttling">
131-
If burstable instances use more than their allocated budget, they can become [throttled](../cloud/cloud-overview#budget-credits-and-throttling).
131+
If burstable instances use more than their allocated budget, they can become [throttled](../cloud/cloud-overview.mdx#budget-credits-and-throttling).
132132
</Admonition>
133133

134134
!["Production: Basic"](./assets/tiers-and-instances-0031-production-basic.png)
135135
#### 2. Standard-grade Production Cluster
136-
The resources of standard production clusters are [reserved](../cloud/cloud-overview#reserved-clusters).
136+
The resources of standard production clusters are [reserved](../cloud/cloud-overview.mdx#reserved-clusters).
137137
The cluster can utilize them at all times, and is equipped to handle constant production load.
138138

139139
Use the slide-bars to select your Standard Production cluster's configuration and storage.
@@ -153,7 +153,7 @@ high I/O latencies, RavenDB will alert you to the issue so you can upgrade the t
153153
number of IOPS reserved for your instances.
154154
#### 3. Performance-grade Production Cluster
155155

156-
Performance tier cluster are special [reserved](../cloud/cloud-overview#reserved-clusters) production clusters featuring high-throughput and low latency with a directly mapped local NVMe storage. When multiple NVME disks are available, in order to achieve the best possible throughput and to get as many IOPS as possible, multiple NVME volumes are striped together with RAID0.
156+
Performance tier cluster are special [reserved](../cloud/cloud-overview.mdx#reserved-clusters) production clusters featuring high-throughput and low latency with a directly mapped local NVMe storage. When multiple NVME disks are available, in order to achieve the best possible throughput and to get as many IOPS as possible, multiple NVME volumes are striped together with RAID0.
157157

158158
<Admonition type="note" title="Note">
159159
**Scaling up and ephemeral drives**

cloud/cloud-microsoft-azure-marketplace.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,10 +18,10 @@ import LanguageContent from "@site/src/components/LanguageContent";
1818
Access to *RavenDB Cloud* services is available through the *Microsoft Azure Marketplace*.
1919

2020
* In this page:
21-
* [Overview](../cloud/cloud-microsoft-azure-marketplace#overview)
22-
* [Registration process](../cloud/cloud-microsoft-azure-marketplace#registration-process)
23-
* [Subscription cancellation process](../cloud/cloud-microsoft-azure-marketplace#subscription-cancellation-process)
24-
* [Conversion from a regular Cloud Account to an Azure Marketplace Account](../cloud/cloud-microsoft-azure-marketplace#conversion-from-a-regular-cloud-account-to-an-azure-marketplace-account)
21+
* [Overview](../cloud/cloud-microsoft-azure-marketplace.mdx#overview)
22+
* [Registration process](../cloud/cloud-microsoft-azure-marketplace.mdx#registration-process)
23+
* [Subscription cancellation process](../cloud/cloud-microsoft-azure-marketplace.mdx#subscription-cancellation-process)
24+
* [Conversion from a regular Cloud Account to an Azure Marketplace Account](../cloud/cloud-microsoft-azure-marketplace.mdx#conversion-from-a-regular-cloud-account-to-an-azure-marketplace-account)
2525

2626
</Admonition>
2727
## Overview

cloud/cloud-migration.mdx

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ import LanguageContent from "@site/src/components/LanguageContent";
1616
<Admonition type="note" title="Note">
1717

1818
Databases can be migrated between any two instances of RavenDB, including migration between on-premises and
19-
cloud servers and between [different RavenDB versions](../migration/client-api/introduction).
19+
cloud servers and between [different RavenDB versions](../7.1/migration/client-api/introduction).
2020

2121
* In this page
2222
* [Import From Live RavenDB instance](cloud-migration#import-from-live-ravendb-instance)
@@ -26,14 +26,14 @@ cloud servers and between [different RavenDB versions](../migration/client-api/i
2626
</Admonition>
2727
## Import From Live RavenDB Instance
2828

29-
You can easily migrate your database using the [import data from RavenDB](../studio/database/tasks/import-data/import-from-ravendb) operation.
29+
You can easily migrate your database using the [import data from RavenDB](../7.1/studio/database/tasks/import-data/import-from-ravendb) operation.
3030
In order to do so, the **source server** needs to have the **destination server's cluster certificate**.
3131

32-
Open the [Management Studio](../studio/overview) of each server.
33-
Each server's Studio is available in the [Portal](../cloud/portal/cloud-portal#cloud-portal)'s
34-
[Product tab](../cloud/portal/cloud-portal-products-tab#cloud-account-portal-products).
32+
Open the [Management Studio](../7.1/studio/overview) of each server.
33+
Each server's Studio is available in the [Portal](../cloud/portal/cloud-portal.mdx#cloud-portal)'s
34+
[Product tab](../cloud/portal/cloud-portal-products-tab.mdx#cloud-account-portal-products).
3535

36-
Learn how to [install the certificate and access RavenDB Cloud Studio](../cloud/cloud-overview#ravendb-studio---graphic-user-interface) if this is your first time using Cloud Studio.
36+
Learn how to [install the certificate and access RavenDB Cloud Studio](../cloud/cloud-overview.mdx#ravendb-studio---graphic-user-interface) if this is your first time using Cloud Studio.
3737

3838
If you have already installed the certificate and accessed Studio,
3939
click the URLs in the Products tab to open a Studio GUI for each node.
@@ -69,9 +69,9 @@ In the Destination Server, create or select an empty database and open its **Tas
6969

7070
## Import From File
7171

72-
Another option is to [export a database](../studio/database/tasks/export-database) from the source server in the
72+
Another option is to [export a database](../7.1/studio/database/tasks/export-database) from the source server in the
7373
`.ravenDBDump` format, and upload it to another database using the
74-
[import data from file](../studio/database/tasks/import-data/import-data-file) operation.
74+
[import data from file](../7.1/studio/database/tasks/import-data/import-data-file) operation.
7575
This option doesn't require passing certificates:
7676
#### First export the data from source server
7777

@@ -102,10 +102,10 @@ This option doesn't require passing certificates:
102102

103103
* If you've deleted documents from the source database in the last few minutes before live-importing,
104104
the deleted documents will still appear in the destination database.
105-
This is because after deleting a document, a [tombstone](../glossary/tombstone) is left behind as a signal for backups and
105+
This is because after deleting a document, a [tombstone](../7.1/glossary/tombstone) is left behind as a signal for backups and
106106
various behind-the-scene processes.
107107
* Once all of these processes have been completed,
108-
the tombstones are cleaned. They are cleaned every 5 minutes by default. You can configure the [tombstone cleaner time intervals](../server/configuration/tombstone-configuration).
108+
the tombstones are cleaned. They are cleaned every 5 minutes by default. You can configure the [tombstone cleaner time intervals](../7.1/server/configuration/tombstone-configuration).
109109
* After they are cleaned, performing another live-import will show that the documents have been deleted.
110110

111111

0 commit comments

Comments
 (0)