Skip to content

Commit 66096bd

Browse files
committed
Improve Collections creation tutorial
1 parent 25a7b7f commit 66096bd

File tree

2 files changed

+15
-15
lines changed

2 files changed

+15
-15
lines changed

content/collections/tutorials/create.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -11,13 +11,13 @@ By the end, you'll have a working collection that tracks changes to a service's
1111

1212
## Prerequisites
1313

14-
- Node.js installed 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.
1717

1818
## Create a collection
1919

20-
### Step 1: Set up the project structure
20+
### Step 1: Set up the directory structure
2121

2222
1. Create a new directory:
2323
```bash
@@ -37,7 +37,7 @@ By the end, you'll have a working collection that tracks changes to a service's
3737

3838
### Step 2: Create the service declaration
3939

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" >}}):
4141
```json
4242
{
4343
"name": "Open Terms Archive",
@@ -52,11 +52,11 @@ By the end, you'll have a working collection that tracks changes to a service's
5252

5353
### Step 2: Create the metadata file
5454

55-
6. Create a file `metadata.yaml`:
55+
5. Create a file `metadata.yaml`:
5656
```yaml
5757
id: ota-tutorial
5858
name: Tutorial collection
59-
tagline: Learn how to create an Open Terms Archive collection
59+
tagline: Learn how to create a collection
6060
description: |
6161
A step-by-step tutorial collection that guides through creating an Open Terms Archive collection.
6262
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
6666
6767
### Step 3: Create the configuration file
6868
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:
7070
```json
7171
{
7272
"trackingSchedule": "* * * * *"
@@ -75,18 +75,18 @@ By the end, you'll have a working collection that tracks changes to a service's
7575
7676
### Step 4: Install and run the engine
7777
78-
1. Install the Open Terms Archive engine:
78+
7. Install the Open Terms Archive engine:
7979
```bash
8080
npm install --save @opentermsarchive/engine
8181
```
8282
83-
2. Start the scheduled tracking of the declared terms:
83+
8. Start the scheduled tracking of the declared terms:
8484
```bash
8585
npx ota track --schedule
8686
```
8787
88-
3. After one minute, check the results:
89-
- Check the extracted version, which should contain the Privacy Policy of Open Terms Archive in the 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 in Markdown 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`.
9191
9292
Congratulations! You have created your first collection.

content/terms/tutorials/track.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ By the end, you'll have tracked a service's privacy policy. You will also have a
1717

1818
## Track terms
1919

20-
### Step 1: Set up the structure
20+
### Step 1: Set up the directory structure
2121

2222
1. Create a new directory:
2323
```bash
@@ -73,7 +73,7 @@ The resulting declaration should look something like this:
7373
```
7474

7575
3. Verify the results:
76-
- Check the extracted version, which should contain the Privacy Policy of Open Terms Archive in the 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`.
7777
- Check the snapshot, which is the original HTML document of the Open Terms Archive Privacy Policy: `./data/snapshots/Open Terms Archive/Privacy Policy.html`.
7878

7979
Congratulations! You have tracked your first terms.

0 commit comments

Comments
 (0)