Skip to content

Commit 6a262c5

Browse files
correct links
1 parent dd896a2 commit 6a262c5

File tree

5 files changed

+60
-9
lines changed

5 files changed

+60
-9
lines changed

README.md

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -167,4 +167,56 @@ Edit `themes/hugo-docs/layouts/partials/sidebar.html` and add:
167167
{{ if eq $menuType "yourtype" }}
168168
{{ $menu = .Site.Menus.yourtype }}
169169
{{ end }}
170+
```
171+
172+
## Multi-Version Documentation
173+
174+
This repository uses a build script to generate documentation for multiple versions from different Git branches.
175+
176+
177+
```bash
178+
./scripts/build.sh
179+
```
180+
181+
This builds:
182+
- **Latest docs** from `main` branch → `/`
183+
- **Version docs** from release branches → `/v24.1/`, etc.
184+
185+
## How It Works
186+
187+
1. **Build Script** (`build.sh`) uses Git worktrees to temporarily check out each release branch
188+
2. **Hugo builds** each version into its own subdirectory with the appropriate base URL
189+
3. **Version selector** loads available versions from `versions.json` and displays a dropdown
190+
191+
## Configuration
192+
193+
Edit `build.sh` to add/remove versions:
194+
```bash
195+
VERSION_BRANCHES=("main" "release/v24.1")
196+
```
197+
198+
```bash
199+
VERSION_BRANCHES=("release/v25.0" "release/v24.1")
200+
```
201+
202+
## File Structure
203+
204+
```
205+
layouts/partials/
206+
└── version-selector.html # Dropdown component
207+
scripts/
208+
└── build.sh # Build script
209+
public/ # Generated output
210+
├── index.html # Latest docs (main)
211+
├── versions.json # Version metadata
212+
├── v24.1/ # Version 24.1 docs
213+
└── v24.2/ # Version 24.2 docs
214+
```
215+
216+
### Version Selector
217+
218+
In layout
219+
220+
```html
221+
{{ partial "version-selector.html" . }}
170222
```

content/cli/decrypt.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,8 @@ You might need to decrypt data from an encrypted Dgraph cluster for a variety of
1111
* Migration of data from an encrypted cluster to a non-encrypted cluster
1212
* Changing your data or schema by directly editing an RDF file or schema file
1313

14-
To support these scenarios, Dgraph includes a `decrypt` command that decrypts encrypted RDF and schema files. To learn how to export RDF
15-
and schema files from Dgraph, see:
16-
[Dgraph Administration: Export database](/deploy/admin/dgraph-administration/#export-database).
14+
To support these scenarios, Dgraph includes a `decrypt` command that decrypts encrypted RDF and schema files. To learn how to export RDF and schema files from Dgraph, see:
15+
[Dgraph Administration: Export database]({{< relref "export-data">}}).
1716

1817
The `decrypt` command supports a variety of symmetric key lengths, which
1918
determine the AES cypher used for encryption and decryption, as follows:

content/dgraph-overview.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ Dgraph is built from the ground up as a distributed system. Data is automaticall
5252

5353
Each Dgraph cluster consists of multiple server groups (shards) that work together to store and query your data. Queries are automatically distributed across the relevant shards and results are aggregated, making the distributed nature transparent to your application. This architecture provides both horizontal scalability and high availability.
5454

55-
For detailed information about Dgraph's distributed architecture, clustering, and replication, see the [Architecture documentation](/deploy/dgraph-architecture).
55+
For detailed information about Dgraph's distributed architecture, clustering, and replication, see the [Architecture documentation]({{< relref "dgraph-architecture">}}).
5656

5757
## Enterprise-Grade Features
5858

content/graphql-dql/graphql-data-loading.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,11 @@ type = "graphql"
1212

1313
After you have deployed your first GraphQL Schema, you get a GraphQL API served on ``/graphql`` endpoint and an empty backend. You can populate the graph database using the mutations operations on the GraphQL API.
1414

15-
A more efficient way to populate the database is to use the Dgraph's [import tools](/howto/importdata/).
15+
A more efficient way to populate the database is to use the Dgraph's [import tools]({{< relref "import-data">}}).
1616

1717
The first step is to understand the [schema mapping]({{<relref "graphql-dql-schema">}}) and to prepare your RDF files or JSON files to follow the internal Dgraph predicates names.
1818
You also have to make sure that you properly generate data for the `dgraph.type` predicate so that each node is asscociated with it's type.
1919

20-
If you are using the [initial import](/howto/importdata/bulk-loader/) tool, you can provide the GraphQL schema along with the data to import when executing the bulk load.
20+
If you are using the [initial import]({{< relref "bulk-loader">}}) tool, you can provide the GraphQL schema along with the data to import when executing the bulk load.
2121

22-
If you are using the [live import](/howto/importdata/live-loader/) tool, you must first deploy your GraphQL Schema and then proceed with the import. Deploying the schema first, will generate the predicates indexes and reduce the loading time.
22+
If you are using the [live import]({{< relref "live-loader">}}) tool, you must first deploy your GraphQL Schema and then proceed with the import. Deploying the schema first, will generate the predicates indexes and reduce the loading time.

content/graphql-dql/graphql-dql-schema.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ The API and the engine logic are generated from the schema defining the types of
4141

4242
### In DQL, the schema described the predicates
4343

44-
Dgraph maintains a list of all predicates names with their type and indexes in the [Dgraph types schema](/dql/dql-schema/).
44+
Dgraph maintains a list of all predicates names with their type and indexes in the [Dgraph types schema]({{< relref "dql-schema">}}).
4545

4646

4747
### Schema mapping
@@ -159,7 +159,7 @@ type Property {
159159
The fact that the GraphQL API backend is a graph in Dgraph, implies that you can use Dgraph DQL on the data that is also served by the GraphQL API operations.
160160

161161
In particular, you can
162-
- use Dgraph DQL mutations but also Dgraph's [import tools](/howto/importdata/) to populate the graph after you have deployed a GraphQL Schema. See [GraphQL data loading]({{<relref "graphql-data-loading.md">}})
162+
- use Dgraph DQL mutations but also Dgraph's [import tools]({{< relref "import-data">}}) to populate the graph after you have deployed a GraphQL Schema. See [GraphQL data loading]({{<relref "graphql-data-loading.md">}})
163163
- use DQL to query the graph in the context of authorization rules and custom resolvers.
164164
- add knowledge to your graph such as meta-data, score, annotations, ..., but also relationships or relationships attributes (facets) that could be the result of similarity computation, threat detection a.s.o. The added data could be hidden from your GraphQL API clients but be available to logic written with DQL clients.
165165
- break things using DQL: DQL is powerful and is bypassing constraints expressed in the GraphQL schema. You can for example delete a node predicate that is mandatory in the GraphQL API! Hopefully there are ways to secure who can read/write/delete predicates. ( see the [ACL](/enterprise-features/access-control-lists/)) section.

0 commit comments

Comments
 (0)