Skip to content

Commit 46fefe8

Browse files
committed
Improve collections how to
1 parent 66096bd commit 46fefe8

File tree

2 files changed

+45
-67
lines changed

2 files changed

+45
-67
lines changed

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

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -116,10 +116,3 @@ For collections within the Open Terms Archive organization:
116116
- Versions repository: "Triage" access
117117
4. Add team members
118118
5. Add repositories to Bots team with "Write" access
119-
120-
## Verify setup
121-
122-
1. Check that all repositories were created successfully
123-
2. Verify repository settings are correctly configured
124-
3. Ensure team permissions are properly set
125-
4. Test basic operations (e.g., creating an issue, making a PR)

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

Lines changed: 45 additions & 60 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ weight: 2
55

66
# How to define metadata
77

8-
This guide will help you create the metadata.yml file for your Open Terms Archive collection.
8+
This guide will help you define the metadata for your Open Terms Archive collection.
99

1010
## Prerequisites
1111

@@ -18,68 +18,53 @@ This guide will help you create the metadata.yml file for your Open Terms Archiv
1818
1. Create a new file named `metadata.yml` in your collection's root directory.
1919

2020
2. Define the required basic information:
21-
```yaml
22-
name: "Your Collection Name" # Keep it under 3 words
23-
id: "your-collection-id" # Create a simple dash-separated identifier
24-
tagline: "Brief description" # Write a one-line collection summary
25-
languages: ["en"] # List ISO 639 language codes
26-
jurisdictions: ["US"] # List ISO 3166-2 country codes
27-
```
28-
29-
3. Add detailed description and URLs:
30-
```yaml
31-
description: "A more detailed explanation of your collection's purpose"
32-
dataset: "https://github.com/YourOrg/your-collection-versions/releases"
33-
declarations: "https://github.com/YourOrg/your-collection-declarations"
34-
versions: "https://github.com/YourOrg/your-collection-versions"
35-
snapshots: "https://github.com/YourOrg/your-collection-snapshots"
36-
```
37-
38-
4. Configure tracking periods:
39-
```yaml
40-
trackingPeriods:
41-
- startDate: "YYYY-MM-DD" # When tracking begins
42-
schedule: "0 0 * * *" # Cron expression for frequency
43-
serverLocation: "City, CC" # Server location (City, Country code)
44-
```
4521

46-
5. Define governance structure:
47-
```yaml
48-
governance:
49-
hosts:
50-
- name: "Host Organization"
51-
url: "https://organization-website.com"
52-
logo: "https://path-to-logo.png"
53-
administrators:
54-
- name: "Admin Organization"
55-
url: "https://admin-website.com"
56-
logo: "https://path-to-logo.png"
57-
```
58-
59-
6. Add optional fields as needed:
60-
```yaml
61-
logo: "https://path-to-collection-logo.png"
62-
donation: "https://donation-page-url.com"
63-
```
64-
65-
7. Validate your YAML syntax using a YAML validator.
22+
```yaml
23+
name: "Your Collection Name" # Keep it under 3 words
24+
id: "your-collection-id" # Create a simple dash-separated identifier
25+
tagline: "Brief description" # Write a one-line collection summary
26+
languages: ["en"] # List ISO 639 language codes
27+
jurisdictions: ["US"] # List ISO 3166-2 country codes
28+
```
29+
30+
3. Add detailed description and repositories URLs:
31+
32+
```yaml
33+
description: "A more detailed explanation of your collection's purpose"
34+
dataset: "https://github.com/YourOrg/your-collection-versions/releases"
35+
declarations: "https://github.com/YourOrg/your-collection-declarations"
36+
versions: "https://github.com/YourOrg/your-collection-versions"
37+
snapshots: "https://github.com/YourOrg/your-collection-snapshots"
38+
```
39+
40+
4. Define tracking periods:
41+
42+
```yaml
43+
trackingPeriods:
44+
- startDate: "YYYY-MM-DD" # When tracking begins
45+
schedule: "0 0 * * *" # Cron expression for frequency
46+
serverLocation: "City, CC" # Server location (City, Country code)
47+
```
6648
67-
## Validation
68-
69-
Ensure your metadata file:
70-
- Contains all required fields
71-
- Uses correct YAML syntax
72-
- Has valid URLs
73-
- Uses proper date formats (YYYY-MM-DD)
74-
- Contains valid language and jurisdiction codes
49+
5. Define governance structure:
7550
76-
## Result
51+
```yaml
52+
governance:
53+
- name: "Host entity"
54+
url: "https://entity-website.com"
55+
logo: "https://path-to-logo.png"
56+
roles: ["curator", "maintainer"]
57+
- name: "Admin entity"
58+
url: "https://admin-website.com"
59+
logo: "https://path-to-logo.png"
60+
roles: ["administrator"]
61+
```
7762
78-
A properly configured `metadata.yml` file in your collection's root directory that defines your collection's essential characteristics and operational parameters.
63+
6. Add optional fields as needed:
7964
80-
## Next Steps
65+
```yaml
66+
logo: "https://path-to-collection-logo.png"
67+
donations: "https://donation-page-url.com"
68+
```
8169
82-
After creating your metadata.yml file:
83-
1. Commit it to your collection's repository
84-
2. Test it with the Open Terms Archive engine
85-
3. Update as needed based on validation results
70+
7. Validate your YAML syntax using a YAML validator.

0 commit comments

Comments
 (0)