Skip to content

Commit 0fd7310

Browse files
committed
Fix links
1 parent eb66ab9 commit 0fd7310

File tree

2 files changed

+7
-7
lines changed

2 files changed

+7
-7
lines changed

content/contributing-terms.en.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ To add a declaration, you need to follow these steps:
2323
1. Clone the [contrib-declaration](https://github.com/OpenTermsArchive/contrib-declarations) repository to your local machine.
2424
2. Create a branch that describes your contribution e.g. `add-Open-Terms-Archive-ToS` or `add-firefox-privacy-policy`
2525
3. Run `npm install`. This will install all the dependencies including the Open Terms Archive engine which will allow you to test and validate your declaration.
26-
4. Create a JSON file with, as filename, the service ID of the service you are adding the declaration for. This JSON file should be in the `declarations` folder of the repository. To learn more about selecting the right service ID, please read the [declaring a new service](reference/declaration#declaring-a-new-service) section.
26+
4. Create a JSON file with, as filename, the service ID of the service you are adding the declaration for. This JSON file should be in the `declarations` folder of the repository. To learn more about selecting the right service ID, please read the [declaring a new service]({{< relref "reference/declaration#declaring-a-new-service" >}}) section.
2727
5. Visit the declaration URL and use [browser developer tools](https://developer.mozilla.org/en-US/docs/Learn/Common_questions/Tools_and_setup/What_are_browser_developer_tools) to inspect the page and find the right selectors for the significant section containing the terms you want to declare and parts to remove.
2828
6. After you've properly chosen your selectors and structured your JSON file, you should test and validate your JSON file. To do this, you need to run `npx ota validate --services [service name]` from the root of the repository. This will run a validation on the declaration, highlighting any changes required.
2929
7. If all tests pass, open a pull request to the main repository.

content/reference/declaration.en.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ The service name is exposed to end users. It should reflect as closely as possib
3434
- _Example: `Firebase` (by Google) → `Firebase`_.
3535
- _Example: `App Store` (by Apple) → `App Store`_.
3636

37-
> If you have a hard time finding the service name, check out the [practical guidelines to find the service name](declarations-guidelines.md#service-name), and feel free to mention your uncertainties in the pull request! We will help you improve the service name if necessary 🙂
37+
> If you have a hard time finding the service name, check out the [practical guidelines to find the service name]({{< relref "guidelines/declaring#service-name" >}}), and feel free to mention your uncertainties in the pull request! We will help you improve the service name if necessary 🙂
3838
3939
### Service ID
4040

@@ -54,7 +54,7 @@ The service ID is exposed to developers. It should be easy to handle with script
5454
- _Example: `App Store``App Store`_.
5555
- _Example: `DeviantArt``DeviantArt`_.
5656

57-
> If you have a hard time defining the service ID, check out the [practical guidelines to derive the ID from the service name](declarations-guidelines.md#service-id), and feel free to mention your uncertainties in the pull request! We will help you improve the service ID if necessary 🙂
57+
> If you have a hard time defining the service ID, check out the [practical guidelines to derive the ID from the service name]({{< relref "guidelines/declaring#service-id" >}}), and feel free to mention your uncertainties in the pull request! We will help you improve the service ID if necessary 🙂
5858
> More details on the ID and naming constraints and recommendations can be found in the relevant [decision record](https://github.com/OpenTermsArchive/engine/blob/main/decision-records/0001-service-name-and-id.md).
5959
6060
### Service declaration
@@ -101,13 +101,13 @@ Let’s start by defining these keys!
101101

102102
This property should simply contain the URL at which the terms you want to track can be downloaded. HTML and PDF files are supported.
103103

104-
When terms coexist in different languages and jurisdictions, please refer to the [scope of the collection](../README.md#collections) to which you are contributing. This scope is usually defined in the README.
104+
When terms coexist in different languages and jurisdictions, please refer to the [scope of the collection]({{< relref "/#collections" >}}) to which you are contributing. This scope is usually defined in the README.
105105

106106
#### `select`
107107

108108
_This property is not needed for PDF documents._
109109

110-
Most of the time, contractual documents are exposed as web pages, with a header, a footer, navigation menus, possibly ads… We aim at tracking only the significant parts of the document. In order to achieve that, the `select` property allows to extract only those parts in the process of [converting from snapshot to version](../README.md#how-it-works).
110+
Most of the time, contractual documents are exposed as web pages, with a header, a footer, navigation menus, possibly ads… We aim at tracking only the significant parts of the document. In order to achieve that, the `select` property allows to extract only those parts in the process of [converting from snapshot to version](https://opentermsarchive.org/#how-it-works).
111111

112112
The `select` value can be either a [CSS selector](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_Selectors), a [range selector](#range-selectors) or an array of those.
113113

@@ -265,7 +265,7 @@ Each filter is exposed as a named function export that takes a `document` parame
265265

266266
> The `document` parameter is actually a [JSDOM](https://github.com/jsdom/jsdom) document instance.
267267

268-
You can learn more about usual noise and ways to handle it [in the guidelines](declarations-guidelines.md#Usual-noise).
268+
You can learn more about usual noise and ways to handle it [in the guidelines]({{< relref "guidelines/declaring#usual-noise" >}}).
269269

270270
##### Example
271271

@@ -399,7 +399,7 @@ If the terms you want to add match no existing type, you can [suggest a new one]
399399

400400
##### Defining new terms types
401401

402-
Before defining a new terms type, please note that wanting to multiply terms types is usually a symptom that the service needs to be broken down into several services. For example, rather than considering that Facebook has several specific variations of “Terms of Service”, it is more accurate to declare “Terms of Service” for the services “Facebook” (social network service for the general public), “Facebook Ads” (ads service for advertisers) and “Facebook Payments” (payment service for developers). On the other hand, the “Google Ads” service is a commercial suite acting as an umbrella for several pieces of software that all share the same terms, and there is thus no need to separate each of them. See practical guidelines for [provider prefixing](declarations-guidelines.md#provider-prefixing).
402+
Before defining a new terms type, please note that wanting to multiply terms types is usually a symptom that the service needs to be broken down into several services. For example, rather than considering that Facebook has several specific variations of “Terms of Service”, it is more accurate to declare “Terms of Service” for the services “Facebook” (social network service for the general public), “Facebook Ads” (ads service for advertisers) and “Facebook Payments” (payment service for developers). On the other hand, the “Google Ads” service is a commercial suite acting as an umbrella for several pieces of software that all share the same terms, and there is thus no need to separate each of them. See practical guidelines for [provider prefixing]({{< relref "guidelines/declaring#provider-prefixing" >}}).
403403

404404
In order to guide usage and disambiguate synonyms, we characterise each terms type along three dimensions of the commitment that is being taken in it:
405405

0 commit comments

Comments
 (0)