Skip to content

Commit bc04f4a

Browse files
committed
Improve how to manage a custom terms type
1 parent 115e36e commit bc04f4a

File tree

1 file changed

+5
-27
lines changed

1 file changed

+5
-27
lines changed

content/collections/how-to/manage-custom-terms-type.md

Lines changed: 5 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -5,50 +5,28 @@ weight: 6
55

66
# How to manage a custom terms type
77

8-
When tracking terms and conditions across different services, you might encounter situations where a service uses terms types that aren't yet supported by Open Terms Archive.
8+
When tracking terms and conditions across different services, you might encounter situations where a service uses terms types that aren't yet supported by Open Terms Archive.
99
This guide will help you handle these custom terms types effectively, whether you're working on a new collection or expanding an existing one.
1010

11-
## Understanding the validation
12-
13-
Open Terms Archive validates terms types to ensure consistency and quality across collections. When you encounter a validation error like:
14-
15-
```shell
16-
1) Service declarations validation
17-
<service_name>
18-
valid declaration schema:
19-
Error:
20-
21-
data/terms must be equal to one of the allowed values (in entire file)
22-
```
23-
24-
This means the terms type you're trying to use isn't in the official list of supported types.
25-
26-
## Before going further
11+
## Prerequisites
2712

2813
Before proceeding with using a custom terms type, please double-check that the type you're considering doesn't already exist in the supported terms types list. Different services often use different names for the same type of terms. For instance, "Terms and Conditions" might be called "Terms of Use" or "Terms of Service" by different services.
2914

30-
Review the [supported types list](https://github.com/OpenTermsArchive/terms-types/blob/main/termsTypes.json) carefully to ensure the terms type you want to track is not already supported under a different name. If it does, use the associated type in your declaration. If you are sure it's not supported, you can proceed with the following steps. If you're unsure, you can ask for help in the [Open Terms Archive community]({{< relref "community/how-to/join" >}}).
15+
Review the [supported types list](https://github.com/OpenTermsArchive/terms-types/blob/main/termsTypes.json) carefully to ensure the terms type you want to track is not already supported under a different name. If it does, use the associated type in your declaration. If you are sure it's not supported, you can proceed with the following steps. If you're unsure, you can ask for help in the [Open Terms Archive community]({{< relref "community/how-to/join" >}}).
3116

3217
## Long-term solution
3318

3419
The recommended approach is to contribute your new terms type to the official list. This enables collections interoperability and comparison of terms across different services.
3520

3621
You can suggest new terms type for the official list via the dedicated [contribution process](https://github.com/OpenTermsArchive/terms-types/blob/main/CONTRIBUTING.md#add-new-terms-types).
3722

38-
This process has the following benefits:
39-
40-
- Your terms type becomes available to all collections
41-
- You don't need to maintain a custom fork
42-
- It helps build a more comprehensive and useful shared list
43-
- Enables better comparison of terms across different services
44-
4523
Inclusion in the official terms types list has a delay for consensus building. In the meantime, you can proceed with the following temporary solutions.
4624

4725
## Temporary solutions
4826

4927
### For proof of concept or development
5028

51-
As the validation is primarily intended for production environments to maintain consistency, if you're working on a proof of concept or development environment that won't be deployed to production, you can safely ignore these validation errors, the whole tracking process will still work.
29+
As the validation is primarily intended for production environments to maintain consistency, if you're working on a proof of concept or development environment that won't be deployed to production, you can safely ignore terms types validation errors, the whole tracking process will still work.
5230

5331
### Using a forked version
5432

@@ -67,4 +45,4 @@ If you need a faster solution for production use, you can fork the terms-types r
6745
}
6846
```
6947

70-
This solution is only recommended as a temporary solution, it is strongly recommended that you also submit the new terms type through the process describe in previous section. This way, you'll contribute to the community by helping maintain consistency across collections and enables better comparison of terms across different services, and also eventually stop maintaining a custom fork.
48+
This solution is only recommended as a **temporary** solution, it is strongly recommended that you also submit the new terms type through the process describe in previous section. This way, you'll contribute to the community by helping maintain consistency across collections and enables better comparison of terms across different services, and also eventually stop maintaining a custom fork.

0 commit comments

Comments
 (0)