You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: content/collections/tutorials/create.md
+13-13Lines changed: 13 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,13 +11,13 @@ By the end, you'll have a working collection that tracks changes to a service's
11
11
12
12
## Prerequisites
13
13
14
-
- Node.jsinstalled on your system
15
-
-Basic familiarity with the command line
16
-
-A text editor
14
+
-[Node.js](https://nodejs.org/en) is installed on your system.
15
+
-You have basic familiarity with the command line.
16
+
-You know how to use a text editor.
17
17
18
18
## Create a collection
19
19
20
-
### Step 1: Set up the project structure
20
+
### Step 1: Set up the directory structure
21
21
22
22
1. Create a new directory:
23
23
```bash
@@ -37,7 +37,7 @@ By the end, you'll have a working collection that tracks changes to a service's
37
37
38
38
### Step 2: Create the service declaration
39
39
40
-
4. Create a file `declarations/Open Terms Archive.js` with the basic structure, the first thing to declare is the service name:
40
+
4. Create a file `declarations/Open Terms Archive.json` with the following content. For detailed instructions on how to structure it, follow the [Tracking terms tutorial]({{< relref "/terms/tutorials/track">}}):
41
41
```json
42
42
{
43
43
"name": "Open Terms Archive",
@@ -52,11 +52,11 @@ By the end, you'll have a working collection that tracks changes to a service's
52
52
53
53
### Step 2: Create the metadata file
54
54
55
-
6. Create a file `metadata.yaml`:
55
+
5. Create a file `metadata.yaml`:
56
56
```yaml
57
57
id: ota-tutorial
58
58
name: Tutorial collection
59
-
tagline: Learn how to create an Open Terms Archive collection
59
+
tagline: Learn how to create a collection
60
60
description: |
61
61
A step-by-step tutorial collection that guides through creating an Open Terms Archive collection.
62
62
Track terms and conditions from websites while learning the basics of declarations, configuration, and metadata.
@@ -66,7 +66,7 @@ By the end, you'll have a working collection that tracks changes to a service's
66
66
67
67
### Step 3: Create the configuration file
68
68
69
-
5. Create a file `config/development.json` and set the tracking schedule to every minute:
69
+
6. Create a file `config/development.json` and set the tracking schedule to every minute:
70
70
```json
71
71
{
72
72
"trackingSchedule": "* * * * *"
@@ -75,18 +75,18 @@ By the end, you'll have a working collection that tracks changes to a service's
75
75
76
76
### Step 4: Install and run the engine
77
77
78
-
1. Install the Open Terms Archive engine:
78
+
7. Install the Open Terms Archive engine:
79
79
```bash
80
80
npm install --save @opentermsarchive/engine
81
81
```
82
82
83
-
2. Start the scheduled tracking of the declared terms:
83
+
8. Start the scheduled tracking of the declared terms:
84
84
```bash
85
85
npx ota track --schedule
86
86
```
87
87
88
-
3. After one minute, check the results:
89
-
- Check the extracted version, which should contain the Privacy Policy of Open Terms Archive inthe markdown format without insignificant content (like the header, footer, etc.): `./data/versions/Open Terms Archive/Privacy Policy.md`
90
-
- Check the snapshot, which is the original html document of the Open Terms Archive Privacy Policy: `./data/snapshots/Open Terms Archive/Privacy Policy.html`
88
+
9. After one minute, check the results:
89
+
- Check the extracted version, which should contain the Privacy Policy of Open Terms Archive inMarkdown format without any other content (no header, footer…): `./data/versions/Open Terms Archive/Privacy Policy.md`.
90
+
- Check the snapshot, which is the original HTML document of the Open Terms Archive Privacy Policy: `./data/snapshots/Open Terms Archive/Privacy Policy.html`.
91
91
92
92
Congratulations! You have created your first collection.
Copy file name to clipboardExpand all lines: content/terms/tutorials/track.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -17,7 +17,7 @@ By the end, you'll have tracked a service's privacy policy. You will also have a
17
17
18
18
## Track terms
19
19
20
-
### Step 1: Set up the structure
20
+
### Step 1: Set up the directory structure
21
21
22
22
1. Create a new directory:
23
23
```bash
@@ -73,7 +73,7 @@ The resulting declaration should look something like this:
73
73
```
74
74
75
75
3. Verify the results:
76
-
- Check the extracted version, which should contain the Privacy Policy of Open Terms Archive inthe Markdown format without any other content (no header, footer…): `./data/versions/Open Terms Archive/Privacy Policy.md`.
76
+
- Check the extracted version, which should contain the Privacy Policy of Open Terms Archive in Markdown format without any other content (no header, footer…): `./data/versions/Open Terms Archive/Privacy Policy.md`.
77
77
- Check the snapshot, which is the original HTML document of the Open Terms Archive Privacy Policy: `./data/snapshots/Open Terms Archive/Privacy Policy.html`.
78
78
79
79
Congratulations! You have tracked your first terms.
0 commit comments