Skip to content

Commit 8393fe7

Browse files
authored
Update vocabulary for consistency (#161)
2 parents 1241de5 + ffeb966 commit 8393fe7

File tree

12 files changed

+21
-21
lines changed

12 files changed

+21
-21
lines changed

content/_index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ This documentation follows the [Diátaxis](https://diataxis.fr) approach and str
2929

3030
### Table of contents
3131

32-
- **Analysis:** guidance on how to analyze terms changes, from navigating through the history of tracked documents to publishing memos about significant changes.
32+
- **Analysis:** guidance on how to analyze terms changes, from navigating through the history of tracked terms to publishing memos about significant changes.
3333
- **Community:** information on how to participate in the Open Terms Archive community.
3434
- **Terms:** guidance on tracking and maintaining terms declarations.
3535
- **Collections:** guidance on creating and managing collections of tracked terms.

content/analysis/how-to/navigate-history.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ For this guide, we will use the example of the Demo collection. The terms of thi
4848

4949
### Notes
5050

51-
- For long documents, unchanged paragraphs will not be displayed by default. You can manually make them appear by clicking on the small arrows just above or just below the displayed paragraphs:
51+
- For long terms, unchanged paragraphs will not be displayed by default. You can manually make them appear by clicking on the small arrows just above or just below the displayed paragraphs:
5252

5353
![Expand unchanged paragraphs on source diff view](/images/navigate-history/expand-source.png)
5454

content/api/cli.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Once the engine module is installed as a dependency within another module, the `
1010
In these commands:
1111

1212
- `<service_id>` is the case sensitive name of the service declaration file without the extension. For example, for `Twitter.json`, the service ID is `Twitter`.
13-
- `<terms_type>` is the property name used under the `documents` property in the declaration to declare a terms. For example, in the getting started declaration, the terms type declared is `Privacy Policy`.
13+
- `<terms_type>` is the property name used under the `terms` property in the declaration to declare a terms. For example, in the getting started declaration, the terms type declared is `Privacy Policy`.
1414

1515
## Tracking terms
1616

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

+3-3
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,8 @@ weight: 1
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
10-
- Snapshots repository: stores raw snapshots of tracked documents
11-
- Versions repository: stores processed versions of tracked documents
10+
- Snapshots repository: stores raw snapshots of tracked terms
11+
- Versions repository: stores processed versions of tracked terms
1212

1313
This guide assumes you use GitHub. For other Git platforms, adapt these steps accordingly.
1414

@@ -69,7 +69,7 @@ Before starting, ensure you have:
6969
### Configure repository
7070

7171
1. Set up "About" section:
72-
- Add description: "Documents snapshots for `<collection_name>`. Maintained by `<maintainer>`."
72+
- Add description: "Terms snapshots for `<collection_name>`. Maintained by `<maintainer>`."
7373
- Set website: `https://opentermsarchive.org`
7474
- Add standard tags
7575
- Uncheck "Releases", "Packages" and "Deployments"

content/collections/tutorials/create.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ By the end, you'll have a working collection that tracks changes to a service's
4242
```json
4343
{
4444
"name": "Open Terms Archive",
45-
"documents": {
45+
"terms": {
4646
"Privacy Policy": {
4747
"fetch": "https://opentermsarchive.org/en/privacy-policy",
4848
"select": ".textcontent"

content/concepts/main.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ A **declaration** also contains some metadata on the **service** on which the **
4646
> ```json
4747
> {
4848
> "name": "Open Terms Archive",
49-
> "documents": {
49+
> "terms": {
5050
> "Privacy Policy": {
5151
> "fetch": "https://opentermsarchive.org/en/privacy-policy",
5252
> "select": ".textcontent"

content/terms/guidelines/targeting.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,4 +9,4 @@ aliases: /guidelines/targeting/
99

1010
Yes.
1111

12-
For example, documents that would start applying at date in the future are legitimate candidates for tracking. You can this way track if their terms change even before they are applied.
12+
For example, terms that would start applying at date in the future are legitimate candidates for tracking. You can this way track if their terms change even before they are applied.

content/terms/how-to/rename-a-service.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,4 +5,4 @@ linkTitle: Rename a service
55

66
# How to rename a service
77

8-
The consensus is to consider that a service provider renaming a service (for example, `Twitter` to `X`) is akin to terminating the previous service and opening a new one. Therefore, to apply a service renaming, open a pull request that both [terminates the previous service](#how-to-terminate-a-service) and adds a new [service declaration]({{< relref "terms/how-to/track-new-terms#declaring-a-new-service" >}}) with the new service name. You can reuse the `documents` part of the original declaration, but should double-check that the selectors and URLs still match, as a service rename is most often accompanied by a new page layout, a new domain name, and sometimes entirely new terms.
8+
The consensus is to consider that a service provider renaming a service (for example, `Twitter` to `X`) is akin to terminating the previous service and opening a new one. Therefore, to apply a service renaming, open a pull request that both [terminates the previous service](#how-to-terminate-a-service) and adds a new [service declaration]({{< relref "terms/how-to/track-new-terms#declaring-a-new-service" >}}) with the new service name. You can reuse the `terms` part of the original declaration, but should double-check that the selectors and URLs still match, as a service rename is most often accompanied by a new page layout, a new domain name, and sometimes entirely new terms.

content/terms/how-to/terminate-a-service.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,12 @@ linkTitle: Terminate a service
77

88
If the service provider stops offering a service, the associated terms will become unavailable. To mark that service termination in Open Terms Archive and ensure tracking tentatives are stopped, while maintaining the possibility to explore the history:
99

10-
1. Move the existing documents declaration to the service [history file](#terms-declaration-history).
11-
2. Update the declaration to stop tracking all terms, by removing every `<terms type>` entries from the `documents` key in the declaration:
10+
1. Move the existing terms declaration to the service [history file](#terms-declaration-history).
11+
2. Update the declaration to stop tracking all terms, by removing every `<terms type>` entries from the `terms` key in the declaration:
1212

1313
```json
1414
{
1515
"name": "<service name>",
16-
"documents": {}
16+
"terms": {}
1717
}
1818
```

content/terms/how-to/track-new-terms.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -82,8 +82,8 @@ Once you have the [service name](#service-name) and the [service ID](#service-id
8282
```json
8383
{
8484
"name": "<service name>",
85-
"documents": {}
85+
"terms": {}
8686
}
8787
```
8888

89-
Within the `documents` JSON object, you will now declare terms.
89+
Within the `terms` JSON object, you will now declare terms.

content/terms/reference/declaration.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ aliases: "/terms/reference/"
55

66
# Terms declaration format reference
77

8-
Terms are declared in a service declaration file, under the `documents` property.
8+
Terms are declared in a service declaration file, under the `terms` property.
99

1010
Most of the time, terms are written in only one source document (for example [Facebook Terms of Service](https://www.facebook.com/legal/terms)) but sometimes terms can be spread across multiple online source documents, and their combination constitutes the terms (for example [Facebook Community Guidelines](https://transparency.fb.com/policies/community-standards/)).
1111

@@ -257,7 +257,7 @@ In the case where terms are extracted from one single source document, they are
257257

258258
```json
259259
260-
"documents": {
260+
"terms": {
261261
"<terms type>": {
262262
"fetch": "",
263263
"executeClientScripts": "",
@@ -275,7 +275,7 @@ When the terms are spread across multiple source documents, they should be decla
275275

276276
```json
277277
278-
"documents": {
278+
"terms": {
279279
"<terms type>": {
280280
"combine": [
281281
{
@@ -302,7 +302,7 @@ If some parts of the source documents are repeated, they can be factorised. For
302302

303303
```json
304304
305-
"documents": {
305+
"terms": {
306306
"<terms type>":
307307
"executeClientScripts": "",
308308
"filter": "",
@@ -322,7 +322,7 @@ If some parts of the source documents are repeated, they can be factorised. For
322322

323323
## Terms type
324324

325-
Great, your terms declaration is now almost complete! You simply need to write it under the appropriate terms type in the `documents` JSON object within the service declaration.
325+
Great, your terms declaration is now almost complete! You simply need to write it under the appropriate terms type in the `terms` JSON object within the service declaration.
326326

327327
In order to distinguish between the many terms that can be associated with a service and enable cross-services comparison of similar terms, we maintain a unique list of terms types in a [dedicated repository](https://github.com/OpenTermsArchive/terms-types).
328328

content/terms/tutorials/track.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ The resulting declaration should look something like this:
5151
```json
5252
{
5353
"name": "Open Terms Archive",
54-
"documents": {
54+
"terms": {
5555
"Privacy Policy": {
5656
"fetch": "https://opentermsarchive.org/en/privacy-policy",
5757
"select": ".textcontent"

0 commit comments

Comments
 (0)