Skip to content

Commit 0946283

Browse files
committed
Improve terms tracking tutorial
1 parent cf3800e commit 0946283

File tree

1 file changed

+12
-11
lines changed

1 file changed

+12
-11
lines changed

content/terms/tutorials/track.md

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -7,15 +7,16 @@ weight: 1
77

88
This tutorial will guide you through tracking your first terms.
99

10-
By the end, you'll have tracked a service's privacy policy. You will also have a basic understanding of how to declare a terms to track and how to run the engine.
10+
By the end, you'll have tracked a service's privacy policy. You will also have a basic understanding of how to run the engine to track terms.
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 have basic familiarity with HTML and CSS selectors.
17+
- You know how to use a text editor.
1718

18-
## Track a terms
19+
## Track terms
1920

2021
### Step 1: Set up the structure
2122

@@ -34,20 +35,20 @@ By the end, you'll have tracked a service's privacy policy. You will also have a
3435

3536
For this tutorial, we will use the Privacy Policy of Open Terms Archive as an example.
3637

37-
1. Create a file `declarations/Open Terms Archive.js` with the basic structure, the first thing to declare is the service name:
38+
Create a file `declarations/Open Terms Archive.json`. The name of the file is the name of the service that will be tracked. The first thing to declare is the tracked service name:
3839
```json
3940
{
4041
"name": "Open Terms Archive"
4142
}
4243
```
4344

44-
Now, you can add a terms you want to track to the declaration. For this example, we will use the Privacy Policy of Open Terms Archive.
45+
Now, you can add terms you want to track to the declaration. For this example, we will use the Privacy Policy.
4546

46-
You can go on the open terms archive website and copy the URL of the Privacy Policy to fill the `fetch` field.
47+
You can go on the Open Terms Archive [website](https://opentermsarchive.org/) and copy the URL of its [Privacy Policy](https://opentermsarchive.org/en/privacy-policy/) to fill the `fetch` field.
4748

4849
And you can inspect the HTML of the page to get the selector of the content you want to extract to fill the `select` field.
4950

50-
2. Add the Privacy Policy document configuration:
51+
The resulting declaration should look something like this:
5152
```json
5253
{
5354
"name": "Open Terms Archive",
@@ -73,7 +74,7 @@ And you can inspect the HTML of the page to get the selector of the content you
7374
```
7475

7576
3. Verify the results:
76-
- 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`
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`
77+
- 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`.
78+
- Check the snapshot, which is the original HTML document of the Open Terms Archive Privacy Policy: `./data/snapshots/Open Terms Archive/Privacy Policy.html`.
7879

7980
Congratulations! You have tracked your first terms.

0 commit comments

Comments
 (0)