Skip to content

Commit 1c24b5c

Browse files
authored
Merge pull request #2146 from Danielle9897/RDoc-3517-fixTables
RDoc-3517 Fix tables in new docs
2 parents 6a1a74a + 2b09fda commit 1c24b5c

File tree

114 files changed

+626
-738
lines changed

Some content is hidden

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

114 files changed

+626
-738
lines changed

docs/client-api/operations/_what-are-operations-csharp.mdx

Lines changed: 13 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ import CodeBlock from '@theme/CodeBlock';
6969

7070
* These operations include set-based operations such as _PatchOperation_, _CounterBatchOperation_,
7171
document-extensions related operations such as getting/putting an attachment, and more.
72-
See all available operations [below](../../client-api/operations/what-are-operations.mdx#operations-list).
72+
See all available operations [below](../../client-api/operations/what-are-operations#the-following-common-operations-are-available).
7373

7474
* To execute a common operation request,
7575
use the `Send` method on the `Operations` property of the DocumentStore.
@@ -141,7 +141,8 @@ Task<PatchOperation.Result<TEntity>> SendAsync<TEntity>(PatchOperation<TEntity>
141141

142142
<Admonition type="note" title="">
143143

144-
&lt;span id="operations-list"&gt; **The following common operations are available:** &lt;/span&gt;
144+
#### The following common operations are available:
145+
145146
* **Attachments**:
146147
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; [PutAttachmentOperation](../../client-api/operations/attachments/put-attachment.mdx)
147148
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; [GetAttachmentOperation](../../client-api/operations/attachments/get-attachment.mdx)
@@ -185,7 +186,7 @@ Task<PatchOperation.Result<TEntity>> SendAsync<TEntity>(PatchOperation<TEntity>
185186

186187
* These operations include database management operations such as setting client configuration,
187188
managing indexes & ongoing-tasks operations, getting stats, and more.
188-
See all available maintenance operations [below](../../client-api/operations/what-are-operations.mdx#maintenance-list).
189+
See all available maintenance operations [below](../../client-api/operations/what-are-operations#the-following-maintenance-operations-are-available).
189190

190191
* To execute a maintenance operation request,
191192
use the `Send` method on the `Maintenance` property in the DocumentStore.
@@ -255,7 +256,8 @@ Task<Operation> SendAsync(IMaintenanceOperation<OperationIdResult> operation,
255256

256257
<Admonition type="note" title="">
257258

258-
&lt;span id="maintenance-list"&gt; **The following maintenance operations are available:** &lt;/span&gt;
259+
#### The following maintenance operations are available:
260+
259261
* **Statistics**:
260262
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; [GetStatisticsOperation](../../client-api/operations/maintenance/get-stats.mdx#get-database-stats)
261263
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; [GetDetailedStatisticsOperation](../../client-api/operations/maintenance/get-stats.mdx#get-detailed-database-stats)
@@ -382,7 +384,7 @@ Task<Operation> SendAsync(IMaintenanceOperation<OperationIdResult> operation,
382384
Use [ForNode](../../client-api/operations/how-to/switch-operations-to-a-different-node.mdx) to operate on a specific node other than the default defined in the client configuration.
383385

384386
* These operations include server management and configuration operations.
385-
See all available operations [below](../../client-api/operations/what-are-operations.mdx#server-list).
387+
See all available operations [below](../../client-api/operations/what-are-operations#the-following-server-maintenance-operations-are-available).
386388

387389
* To execute a server-maintenance operation request,
388390
use the `Send` method on the `Maintenance.Server` property in the DocumentStore.
@@ -446,7 +448,8 @@ Task<Operation> SendAsync(IServerOperation<OperationIdResult> operation,
446448

447449
<Admonition type="note" title="">
448450

449-
&lt;span id="server-list"&gt; **The following server-maintenance operations are available:** &lt;/span&gt;
451+
#### The following server-maintenance operations are available:
452+
450453
* **Client certificates**:
451454
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; [PutClientCertificateOperation](../../client-api/operations/server-wide/certificates/put-client-certificate.mdx)
452455
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; [CreateClientCertificateOperation](../../client-api/operations/server-wide/certificates/create-client-certificate.mdx)
@@ -698,10 +701,10 @@ public async Task<TResult> WaitForCompletionAsync<TResult>(CancellationToken tok
698701
</TabItem>
699702
</Tabs>
700703

701-
| Parameter | Type | Description |
702-
|-------------|---------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
703-
| **timeout** | `TimeSpan` | &lt;ul&gt;&lt;li&gt; **When timespan is specified** - <br/>The server will throw a `TimeoutException` if operation has not completed within the specified time frame.<br/>The operation itself continues to run in the background,<br/>no rollback action takes place.&lt;/li&gt;&lt;li&gt;`null` - <br/>WaitForCompletion will wait for operation to complete forever.&lt;/li&gt;&lt;/ul&gt; |
704-
| **token** | `CancellationToken` | &lt;ul&gt;&lt;li&gt; **When cancellation token is specified** - <br/>The server will throw a `TimeoutException` if operation has not completed at cancellation time.<br/>The operation itself continues to run in the background,<br/>no rollback action takes place.&lt;/li&gt;&lt;/ul&gt; |
704+
| Parameter | Type | Description |
705+
|-------------|---------------------|-------------|
706+
| **timeout** | `TimeSpan` | <ul><li><strong>When timespan is specified</strong> -<br/>The server will throw a `TimeoutException` if the operation has not completed within the specified time frame.<br/>The operation itself continues to run in the background,<br/>no rollback action takes place.</li><li>`null` -<br/>WaitForCompletion will wait for the operation to complete forever.</li></ul> |
707+
| **token** | `CancellationToken` | <ul><li><strong>When cancellation token is specified</strong> -<br/>The server will throw a `TimeoutException` if the operation has not completed at cancellation time.<br/>The operation itself continues to run in the background,<br/>no rollback action takes place.</li></ul> |
705708

706709
| Return type | |
707710
|--------------------|-------------------------------|

docs/client-api/operations/_what-are-operations-nodejs.mdx

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ import CodeBlock from '@theme/CodeBlock';
7070

7171
* These operations include set-based operations such as _PatchOperation_, _CounterBatchOperation_,
7272
document-extensions related operations such as getting/putting an attachment, and more.
73-
See all available operations [below](../../client-api/operations/what-are-operations.mdx#operations-list).
73+
See all available operations [below](../../client-api/operations/what-are-operations#the-following-common-operations-are-available).
7474

7575
* To execute a common operation request,
7676
use the `send` method on the `operations` property of the DocumentStore.
@@ -115,7 +115,8 @@ await send(patchOperation, sessionInfo, resultType);
115115

116116
<Admonition type="note" title="">
117117

118-
&lt;span id="operations-list"&gt; __The following common operations are available:__ &lt;/span&gt;
118+
#### The following common operations are available:
119+
119120
* __Attachments__:
120121
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; [PutAttachmentOperation](../../client-api/operations/attachments/put-attachment.mdx)
121122
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; [GetAttachmentOperation](../../client-api/operations/attachments/get-attachment.mdx)
@@ -160,7 +161,7 @@ await send(patchOperation, sessionInfo, resultType);
160161

161162
* These operations include database management operations such as setting client configuration,
162163
managing indexes & ongoing-tasks operations, getting stats, and more.
163-
See all available maintenance operations [below](../../client-api/operations/what-are-operations.mdx#maintenance-list).
164+
See all available maintenance operations [below](../../client-api/operations/what-are-operations#the-following-maintenance-operations-are-available).
164165

165166
* To execute a maintenance operation request,
166167
use the `send` method on the `maintenance` property in the DocumentStore.
@@ -201,7 +202,8 @@ __Send syntax__:
201202

202203
<Admonition type="note" title="">
203204

204-
&lt;span id="maintenance-list"&gt; __The following maintenance operations are available:__ &lt;/span&gt;
205+
#### The following maintenance operations are available:
206+
205207
* __Statistics__:
206208
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; [GetStatisticsOperation](../../client-api/operations/maintenance/get-stats.mdx#get-database-stats)
207209
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; [GetDetailedStatisticsOperation](../../client-api/operations/maintenance/get-stats.mdx#get-detailed-database-stats)
@@ -325,7 +327,7 @@ __Send syntax__:
325327
Use [forNode](../../client-api/operations/how-to/switch-operations-to-a-different-node.mdx) to operate on a specific node other than the default defined in the client configuration.
326328

327329
* These operations include server management and configuration operations.
328-
See all available operations [below](../../client-api/operations/what-are-operations.mdx#server-list).
330+
See all available operations [below](../../client-api/operations/what-are-operations#the-following-server-maintenance-operations-are-available).
329331

330332
* To execute a server-maintenance operation request,
331333
use the `send` method on the `maintenance.server` property of the DocumentStore.
@@ -363,7 +365,8 @@ __Send syntax__:
363365

364366
<Admonition type="note" title="">
365367

366-
&lt;span id="server-list"&gt; __The following server-maintenance operations are available:__ &lt;/span&gt;
368+
#### The following server-maintenance operations are available:
369+
367370
* __Client certificates__:
368371
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; [PutClientCertificateOperation](../../client-api/operations/server-wide/certificates/put-client-certificate.mdx)
369372
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; [CreateClientCertificateOperation](../../client-api/operations/server-wide/certificates/create-client-certificate.mdx)

docs/client-api/operations/_what-are-operations-php.mdx

Lines changed: 12 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ import CodeBlock from '@theme/CodeBlock';
6969

7070
* These operations include set-based operations such as _PatchOperation_, _CounterBatchOperation_,
7171
document-extensions related operations such as getting/putting an attachment, and more.
72-
See all available operations [below](../../client-api/operations/what-are-operations.mdx#operations-list).
72+
See all available operations [below](../../client-api/operations/what-are-operations#the-following-common-operations-are-available).
7373

7474
* To execute a common operation request,
7575
use the `send` method on the `operations` property in the DocumentStore.
@@ -111,7 +111,8 @@ public function send(...$parameters);
111111

112112
<Admonition type="note" title="">
113113

114-
&lt;span id="operations-list"&gt; **The following common operations are available:** &lt;/span&gt;
114+
#### The following common operations are available:
115+
115116
* **Attachments**:
116117
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; [PutAttachmentOperation](../../client-api/operations/attachments/put-attachment.mdx)
117118
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; [GetAttachmentOperation](../../client-api/operations/attachments/get-attachment.mdx)
@@ -154,7 +155,7 @@ public function send(...$parameters);
154155

155156
* These operations include database management operations such as setting client configuration,
156157
managing indexes & ongoing-tasks operations, getting stats, and more.
157-
See all available maintenance operations [below](../../client-api/operations/what-are-operations.mdx#maintenance-list).
158+
See all available maintenance operations [below](../../client-api/operations/what-are-operations#the-following-maintenance-operations-are-available).
158159

159160
* To execute a maintenance operation request,
160161
use the `send` method on the `maintenance` property in the DocumentStore.
@@ -192,7 +193,8 @@ $status = $indexStats->getStatus(); // will be "Paused"
192193

193194
<Admonition type="note" title="">
194195

195-
&lt;span id="maintenance-list"&gt; **The following maintenance operations are available:** &lt;/span&gt;
196+
#### The following maintenance operations are available:
197+
196198
* **Statistics**:
197199
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; [GetStatisticsOperation](../../client-api/operations/maintenance/get-stats.mdx#get-database-stats)
198200
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; [GetDetailedStatisticsOperation](../../client-api/operations/maintenance/get-stats.mdx#get-detailed-database-stats)
@@ -314,7 +316,7 @@ $status = $indexStats->getStatus(); // will be "Paused"
314316
Use [forNode](../../client-api/operations/how-to/switch-operations-to-a-different-node.mdx) to operate on a specific node other than the default defined in the client configuration.
315317

316318
* These operations include server management and configuration operations.
317-
See all available operations [below](../../client-api/operations/what-are-operations.mdx#server-list).
319+
See all available operations [below](../../client-api/operations/what-are-operations#the-following-server-maintenance-operations-are-available).
318320

319321
* To execute a server-maintenance operation request,
320322
use the `send` method on the `maintenance.server` property in the DocumentStore.
@@ -347,7 +349,8 @@ $version = $buildNumberResult->getBuildVersion();
347349

348350
<Admonition type="note" title="">
349351

350-
&lt;span id="server-list"&gt; **The following server-maintenance operations are available:** &lt;/span&gt;
352+
#### The following server-maintenance operations are available:
353+
351354
* **Client certificates**:
352355
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; [PutClientCertificateOperation](../../client-api/operations/server-wide/certificates/put-client-certificate.mdx)
353356
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; [CreateClientCertificateOperation](../../client-api/operations/server-wide/certificates/create-client-certificate.mdx)
@@ -485,10 +488,6 @@ public function waitForCompletion(Duration|int|null $duration = null): void;
485488
</CodeBlock>
486489
</TabItem>
487490

488-
| Parameter | Type | Description |
489-
|---------------|---------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
490-
| **$duration** | `Duration` or `int` | &lt;ul&gt;&lt;li&gt; **When a duration is specified** - <br/>The server will throw a `TimeoutException` if the peration has not completed within the specified time frame.<br/>The operation itself continues to run in the background,<br/>no rollback action takes place.&lt;/li&gt;&lt;li&gt;`null` - <br/>`waitForCompletion` will wait for the operation to complete indefinitely.&lt;/li&gt;&lt;/ul&gt; |
491-
492-
493-
494-
491+
| Parameter | Type | Description |
492+
|---------------|---------------------|-------------|
493+
| **$duration** | `Duration` or `int` | <ul><li><strong>When a duration is specified</strong> -<br/>The server will throw a `TimeoutException` if the operation has not completed within the specified time frame.<br/>The operation itself continues to run in the background,<br/>no rollback action takes place.</li><li>`null` -<br/>`waitForCompletion` will wait for the operation to complete indefinitely.</li></ul> |

docs/client-api/operations/_what-are-operations-python.mdx

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ import CodeBlock from '@theme/CodeBlock';
7070

7171
* These operations include set-based operations such as _PatchOperation_, _CounterBatchOperation_,
7272
document-extensions related operations such as getting/putting an attachment, and more.
73-
See all available operations [below](../../client-api/operations/what-are-operations.mdx#operations-list).
73+
See all available operations [below](../../client-api/operations/what-are-operations#the-following-common-operations-are-available).
7474

7575
* To execute a common operation request,
7676
use the `send` method on the `operations` property of the DocumentStore.
@@ -111,7 +111,8 @@ def send_patch_operation_with_entity_class(
111111

112112
<Admonition type="note" title="">
113113

114-
&lt;span id="operations-list"&gt; **The following common operations are available:** &lt;/span&gt;
114+
#### The following common operations are available:
115+
115116
* **Attachments**:
116117
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; [PutAttachmentOperation](../../client-api/operations/attachments/put-attachment.mdx)
117118
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; [GetAttachmentOperation](../../client-api/operations/attachments/get-attachment.mdx)
@@ -154,7 +155,7 @@ def send_patch_operation_with_entity_class(
154155

155156
* These operations include database management operations such as setting client configuration,
156157
managing indexes & ongoing-tasks operations, getting stats, and more.
157-
See all available maintenance operations [below](../../client-api/operations/what-are-operations.mdx#maintenance-list).
158+
See all available maintenance operations [below](../../client-api/operations/what-are-operations#the-following-maintenance-operations-are-available).
158159

159160
* To execute a maintenance operation request,
160161
use the `send` method on the `maintenance` property in the DocumentStore.
@@ -193,7 +194,8 @@ def send_async(self, operation: MaintenanceOperation[OperationIdResult]) -> Oper
193194

194195
<Admonition type="note" title="">
195196

196-
&lt;span id="maintenance-list"&gt; **The following maintenance operations are available:** &lt;/span&gt;
197+
#### The following maintenance operations are available:
198+
197199
* **Statistics**:
198200
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; [GetStatisticsOperation](../../client-api/operations/maintenance/get-stats.mdx#get-database-stats)
199201
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; [GetDetailedStatisticsOperation](../../client-api/operations/maintenance/get-stats.mdx#get-detailed-database-stats)
@@ -315,7 +317,7 @@ def send_async(self, operation: MaintenanceOperation[OperationIdResult]) -> Oper
315317
Use [for_node](../../client-api/operations/how-to/switch-operations-to-a-different-node.mdx) to operate on a specific node other than the default defined in the client configuration.
316318

317319
* These operations include server management and configuration operations.
318-
See all available operations [below](../../client-api/operations/what-are-operations.mdx#server-list).
320+
See all available operations [below](../../client-api/operations/what-are-operations#the-following-server-maintenance-operations-are-available).
319321

320322
* To execute a server-maintenance operation request,
321323
use the `send` method on the `maintenance.server` property in the DocumentStore.
@@ -361,7 +363,8 @@ with self.embedded_server.get_document_store("WhatAreOperations") as store:
361363

362364
<Admonition type="note" title="">
363365

364-
&lt;span id="server-list"&gt; **The following server-maintenance operations are available:** &lt;/span&gt;
366+
#### The following server-maintenance operations are available:
367+
365368
* **Client certificates**:
366369
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; [PutClientCertificateOperation](../../client-api/operations/server-wide/certificates/put-client-certificate.mdx)
367370
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; [CreateClientCertificateOperation](../../client-api/operations/server-wide/certificates/create-client-certificate.mdx)

0 commit comments

Comments
 (0)