Skip to content

Commit 4f5198d

Browse files
authored
BTS-1704 | DOC-390 | Inverted index primary sort order remark & Tabbify View examples (#369)
* Simplify use of tab shortcodes using positional parameters * Use positional parameter for tabs * Markdownify tab headers * WIP * Complete tabbification * Adjust primary sort example and add remark about mixed directions with standalone inverted indexes * Adjust to new tab shortcode syntax * Apply to 3.11 and 3.10 * fix "a the" and a few similar typos
1 parent 01f4413 commit 4f5198d

File tree

75 files changed

+3205
-1507
lines changed

Some content is hidden

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

75 files changed

+3205
-1507
lines changed

README.md

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -375,19 +375,28 @@ Display content with a tabbed interface, like information for different
375375
operating systems or code examples using different languages.
376376

377377
```markdown
378-
{{< tabs groupid="os" >}}
378+
{{< tabs "os" >}}
379379
380-
{{< tab name="Linux" >}}
380+
{{< tab "Linux" >}}
381381
Run `./script.sh`.
382382
{{< /tab >}}
383383

384-
{{< tab name="Windows" >}}
384+
{{< tab "Windows" >}}
385385
Run `.\script.ps1`.
386386
{{< /tab >}}
387387

388388
{{< /tabs >}}
389389
```
390390

391+
The parameter for the `tabs` shortcode is a group identifier. If there are
392+
multiple tab groups in one page, changing the active tab of one of them also
393+
changes the active tabs of all other groups with the same identifier while
394+
groups with different identifiers are unaffected. The browser remembers the last
395+
active tab of each group.
396+
397+
The parameter for the `tab` shortcode is the label to display for the tab in the
398+
tab panel. Tab groups using the same identifier should use the same tab labels.
399+
391400
#### Figures
392401

393402
If you want to add an image with a caption, use this shortcode instead of the

migration-tools/scripts/homepage_template.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ Find the right deployment type and set up your ArangoDB instance.
2929
{{% /card %}}
3030

3131
{{% card title="Develop topics" link="develop/" %}}
32-
The the in-depth feature and API documentation to start developing application
32+
The in-depth feature and API documentation to start developing application
3333
with ArangoDB as your backend.
3434
{{% /card %}}
3535

site/content/3.10/arangograph/data-loader/_index.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -19,21 +19,21 @@ development effort.
1919

2020
You can get started in a few easy steps.
2121

22-
{{< tabs groupid="data-loader-steps" >}}
22+
{{< tabs "data-loader-steps" >}}
2323

24-
{{< tab name="1. Create database" >}}
24+
{{< tab "1. Create database" >}}
2525
Choose an existing database or create a new one and enter a name for your new graph.
2626
{{< /tab >}}
2727

28-
{{< tab name="2. Add files" >}}
28+
{{< tab "2. Add files" >}}
2929
Drag and drop your data files in CSV format.
3030
{{< /tab >}}
3131

32-
{{< tab name="3. Design your graph" >}}
32+
{{< tab "3. Design your graph" >}}
3333
Model your graph schema by adding nodes and connecting them via edges.
3434
{{< /tab >}}
3535

36-
{{< tab name="4. Import data" >}}
36+
{{< tab "4. Import data" >}}
3737
Once you are ready, save and start the import. The resulting graph is an
3838
[EnterpriseGraph](../../graphs/enterprisegraphs/_index.md) with its
3939
corresponding collections, available in your ArangoDB web interface.

site/content/3.10/develop/http-api/documents.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ database context, use the following URL schema:
3939
http://server:port/_db/<database-name>/_api/document/<document-identifier>
4040
```
4141

42-
For example, using the a database called `mydb`:
42+
For example, using a database called `mydb`:
4343

4444
```
4545
http://localhost:8529/_db/mydb/_api/document/demo/362549736

site/content/3.10/develop/http-api/graphs/named-graphs.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -640,7 +640,7 @@ paths:
640640
description: |
641641
Returned if there is a conflict storing the graph. This can occur
642642
either if a graph with this name is already stored, or if there is one
643-
edge definition with a the same edge collection but a different signature
643+
edge definition with the same edge collection but a different signature
644644
used in any other graph.
645645
content:
646646
application/json:

site/content/3.10/develop/http-api/replication/replication-dump.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ paths:
3939
4040
- `parameters`: the collection properties
4141
42-
- `indexes`: an array of the indexes of a the collection. Primary indexes and edge indexes
42+
- `indexes`: an array of the indexes of the collection. Primary indexes and edge indexes
4343
are not included in this array.
4444
4545
The `state` attribute contains the current state of the replication logger. It

site/content/3.10/develop/integrations/spring-data-arangodb/_index.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -22,15 +22,15 @@ for ArangoDB and provides mapping of Java objects to ArangoDB documents (ODM).
2222

2323
Spring Data ArangoDB is compatible with:
2424

25-
{{< tabs groupid="spring-data" >}}
25+
{{< tabs "spring-data" >}}
2626

27-
{{< tab name="Version 4" >}}
27+
{{< tab "Version 4" >}}
2828
- all the still supported Spring Boot 3.x [versions](https://spring.io/projects/spring-boot#support)
2929
and related Spring Framework versions
3030
- all the still supported ArangoDB [versions](https://www.arangodb.com/eol-notice)
3131
{{< /tab >}}
3232

33-
{{< tab name="Version 3" >}}
33+
{{< tab "Version 3" >}}
3434
- all the still supported Spring Boot 2.x [versions](https://spring.io/projects/spring-boot#support)
3535
and related Spring Framework versions
3636
- all the still supported ArangoDB [versions](https://www.arangodb.com/eol-notice)
@@ -56,9 +56,9 @@ There is a [demonstration app](https://github.com/arangodb/spring-data-demo), wh
5656

5757
## Configuration
5858

59-
{{< tabs groupid="spring-data" >}}
59+
{{< tabs "spring-data" >}}
6060

61-
{{< tab name="Version 4" >}}
61+
{{< tab "Version 4" >}}
6262
You can use Java to configure your Spring Data environment as show below.
6363
Setting up the underlying driver (`ArangoDB.Builder`) with default configuration
6464
automatically loads a properties file `arangodb.properties`, if it exists in the
@@ -97,7 +97,7 @@ public ArangoDB.Builder arango() {
9797
```
9898
{{< /tab >}}
9999

100-
{{< tab name="Version 3" >}}
100+
{{< tab "Version 3" >}}
101101
You can use Java to configure your Spring Data environment as show below.
102102
Setting up the underlying driver (`ArangoDB.Builder`) with default configuration
103103
automatically loads a properties file `arangodb.properties`, if it exists in the
@@ -185,16 +185,16 @@ Spring Boot support is offered by [Spring Boot Starter ArangoDB](https://github.
185185

186186
## Limitations
187187

188-
{{< tabs groupid="spring-data" >}}
188+
{{< tabs "spring-data" >}}
189189

190-
{{< tab name="Version 4" >}}
190+
{{< tab "Version 4" >}}
191191
- Java Record classes and Kotlin Data classes are not supported (DE-539)
192192
- GraalVM Native Image (available with Spring Boot 3) is not supported (DE-677)
193193
- Spring Data REST is not supported (DE-43)
194194
- Spring Data Reactive is not supported (DE-678)
195195
{{< /tab >}}
196196

197-
{{< tab name="Version 3" >}}
197+
{{< tab "Version 3" >}}
198198
- Java Record classes and Kotlin Data classes are not supported (DE-539)
199199
- Spring Data REST is not supported (DE-43)
200200
- Spring Data Reactive is not supported (DE-678)

site/content/3.10/graphs/general-graphs/functions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ archetype: default
99
This chapter describes [various functions on a graph](../_index.md).
1010
A lot of these accept a vertex (or edge) example as parameter as defined in the next section.
1111

12-
Examples will explain the API on the the [City Graph](../example-graphs.md#city-graph):
12+
Examples explain the API using the [City Graph](../example-graphs.md#city-graph):
1313

1414
![Social Example Graph](../../../images/cities_graph.png)
1515

0 commit comments

Comments
 (0)