Skip to content

Commit 8737196

Browse files
committed
Fix order, slug and titles
1 parent 2e10e9f commit 8737196

File tree

20 files changed

+38
-40
lines changed

20 files changed

+38
-40
lines changed
File renamed without changes.

content/api/cli.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
---
2-
title: CLI
2+
title: Command line interface
33
weight: 1
44
---
55

6-
# CLI
6+
# Command line interface
77

88
Once the engine module is installed as a dependency within another module, the `ota` command with the following subcommands is available.
99

content/api/collection.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: Collection REST API
33
weight: 2
44
---
55

6-
# Collection Web API
6+
# Collection REST API
77

88
As Open Terms Archive is decentralised, each instance embarks its own API. The documentation relevant to the specific version of the engine on that instance is provided on that instance itself.
99

content/api/federation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ weight: 3
44
aliases: /api/federated/
55
---
66

7-
# Federation API
7+
# Federation REST API
88

99
Open Terms Archive is a decentralised system that tracks collections of services' terms across multiple servers. Each collection operates its own API, and the Federation API unifies search and discovery across collections, fostering collaboration with external applications.
1010

content/api/node.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Node.JS module
2+
title: Node.js module
33
weight: 1
44
---
55

content/collections/how-to/create-repositories.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: Create repositories
33
weight: 1
44
---
55

6-
# Create Collection Repositories
6+
# How to create collection repositories
77

88
Collections in Open Terms Archive rely on three Git repositories to hold the data:
99
- Declarations repository: stores the declarations that define terms to track
@@ -19,16 +19,16 @@ Before starting, ensure you have:
1919
- Your collection ID and name defined
2020
- Your collection metadata prepared
2121

22-
## Create Declarations Repository
22+
## Create declarations repository
2323

24-
### Create from Template
24+
### Create from template
2525

2626
1. Go to the [`demo-declarations`](https://github.com/OpenTermsArchive/demo-declarations) repository
2727
2. Click "Use this template" dropdown and select "Create a new repository"
2828
3. Name it `<collection_id>-declarations` (e.g. `pga-declarations`)
2929
4. Wait 1-2 minutes for automatic setup to complete (check `first-time-setup` action status)
3030

31-
### Configure Repository Settings
31+
### Configure repository settings
3232

3333
1. Set up the "About" section:
3434
- Click the cogwheel icon next to "About"
@@ -57,16 +57,16 @@ Before starting, ensure you have:
5757
- Update README with collection metadata
5858
- Update `metadata.yml` with collection metadata
5959

60-
## Create Snapshots Repository
60+
## Create snapshots repository
6161

62-
### Create from Template
62+
### Create from template
6363

6464
1. Go to [`demo-snapshots`](https://github.com/OpenTermsArchive/demo-snapshots)
6565
2. Click "Use this template" and select "Create a new repository"
6666
3. Name it `<collection_id>-snapshots`
6767
4. Wait for automatic setup to complete
6868

69-
### Configure Repository
69+
### Configure repository
7070

7171
1. Set up "About" section:
7272
- Add description: "Documents snapshots for `<collection_name>`. Maintained by `<maintainer>`."
@@ -78,16 +78,16 @@ Before starting, ensure you have:
7878
- Disable Wikis, Issues, Discussions, and Projects
7979
- Disable GitHub Actions
8080

81-
## Create Versions Repository
81+
## Create versions repository
8282

83-
### Create from Template
83+
### Create from template
8484

8585
1. Go to [`demo-versions`](https://github.com/OpenTermsArchive/demo-versions)
8686
2. Click "Use this template" and select "Create a new repository"
8787
3. Name it `<collection_id>-versions`
8888
4. Wait for automatic setup to complete
8989

90-
### Configure Repository
90+
### Configure repository
9191

9292
1. Set up "About" section:
9393
- Add description: "Terms versions for `<collection_name>`. Maintained by `<maintainer>`."
@@ -101,7 +101,7 @@ Before starting, ensure you have:
101101

102102
3. Update README with collection metadata
103103

104-
## Set up GitHub Teams
104+
## Set up GitHub teams
105105

106106
For collections within the Open Terms Archive organization:
107107

@@ -117,7 +117,7 @@ For collections within the Open Terms Archive organization:
117117
4. Add team members
118118
5. Add repositories to Bots team with "Write" access
119119

120-
## Verify Setup
120+
## Verify setup
121121

122122
1. Check that all repositories were created successfully
123123
2. Verify repository settings are correctly configured

content/collections/how-to/create-collection.md renamed to content/collections/how-to/create.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
---
2-
title: Creating a collection
2+
title: Create a collection
33
weight: 3
44
---
55

6-
# Creating a collection
6+
# How to create a collection
77

88
You are considering creating a new collection to track terms with Open Terms Archive? Amazing!
99

content/collections/how-to/define-metadata.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
---
2-
title: Define Metadata
2+
title: Define metadata
33
weight: 2
44
---
55

6-
# Define Metadata
6+
# How to define metadata
77

88
This guide will help you create the metadata.yml file for your Open Terms Archive collection.
99

content/collections/reference/configuration.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,14 @@
11
---
22
title: Configuration
3-
weight: 3
3+
weight: 2
44
---
55

66
# Configuration options
77

88
This reference documentation details all available configuration options that can be specified in a collection's configuration file to configure the Open Terms Archive engine.
99

10+
As an example, see the [production configuration file](https://github.com/OpenTermsArchive/demo-declarations/blob/main/config/production.json) of the [Demo collection](https://github.com/OpenTermsArchive/demo-declarations).
11+
1012
## Options
1113

1214
{{< configOption
@@ -298,7 +300,3 @@ The MongoDB storage configuration allows to store versions in a MongoDB database
298300
description="Collection name."
299301
default="`snapshots`"
300302
>}}
301-
302-
---
303-
304-
As an example, see the [production configuration file](https://github.com/OpenTermsArchive/demo-declarations/blob/main/config/production.json) of the [Demo collection](https://github.com/OpenTermsArchive/demo-declarations).

content/collections/reference/environment-variables.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
2-
title: Environment Variables
3-
weight: 4
2+
title: Environment variables
3+
weight: 3
44
---
55

66
## Environment variables

0 commit comments

Comments
 (0)