Skip to content

Commit 25a7b7f

Browse files
committed
Split declarations maintenance how to
1 parent 2c622fb commit 25a7b7f

11 files changed

+52
-40
lines changed

content/terms/declarations-maintenance.en.md renamed to content/terms/declarations-maintenance.md

Lines changed: 1 addition & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: "Declarations maintenance"
3-
weight: 3
3+
weight: 6
44
---
55

66
# Declarations maintenance
@@ -88,40 +88,3 @@ export const removeSharesButton = [
8888
},
8989
];
9090
```
91-
92-
## How to terminate a service
93-
94-
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:
95-
96-
1. Move the existing documents declaration to the service [history file](#terms-declaration-history).
97-
2. Update the declaration to stop tracking all terms, by removing every `<terms type>` entries from the `documents` key in the declaration:
98-
99-
```json
100-
{
101-
"name": "<service name>",
102-
"documents": {}
103-
}
104-
```
105-
106-
## How to rename a service
107-
108-
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/tracking-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.
109-
110-
## How to get the `validUntil` date from an issue
111-
112-
1. Go to the open issue and scroll to the last action from `OTA-Bot` (comment or issue opening).
113-
114-
![]({{< relref "." >}}declarations-maintenance-ota-bot-comment.png)
115-
116-
Note that sometimes:
117-
118-
- the date is not quite precise, it can be written "last month"
119-
![]({{< relref "." >}}declarations-maintenance-ota-bot-comment-last-month.png)
120-
- the last comment may be the announcement of the reopening of the issue
121-
![]({{< relref "." >}}declarations-maintenance-ota-bot-comment-reopened-issue.png)
122-
123-
2. On the date of this comment, right-click "inspect" to open your browser's code inspector.
124-
125-
3. The value to use as `validUntil` is the value of the `datetime` attribute from the `<relative-time>` element.
126-
127-
![]({{< relref "." >}}declarations-maintenance-inspector-open-get-datetime.png)
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
---
2+
title: How to get the `validUntil`
3+
linkTitle: Get the `validUntil` date
4+
---
5+
6+
# How to get the `validUntil` date
7+
8+
## From a GitHub issue
9+
10+
1. Go to the open issue and scroll to the last action from `OTA-Bot` (comment or issue opening).
11+
12+
![]({{< relref "." >}}declarations-maintenance-ota-bot-comment.png)
13+
14+
Note that sometimes:
15+
16+
- the date is not quite precise, it can be written "last month"
17+
![]({{< relref "." >}}declarations-maintenance-ota-bot-comment-last-month.png)
18+
- the last comment may be the announcement of the reopening of the issue
19+
![]({{< relref "." >}}declarations-maintenance-ota-bot-comment-reopened-issue.png)
20+
21+
2. On the date of this comment, right-click "inspect" to open your browser's code inspector.
22+
23+
3. The value to use as `validUntil` is the value of the `datetime` attribute from the `<relative-time>` element.
24+
25+
![]({{< relref "." >}}declarations-maintenance-inspector-open-get-datetime.png)
Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
---
2+
title: How to rename a service
3+
linkTitle: Rename a service
4+
---
5+
6+
# How to rename a service
7+
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/tracking-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.
Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
---
2+
title: How to terminate a service
3+
linkTitle: Terminate a service
4+
---
5+
6+
# How to terminate a service
7+
8+
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:
9+
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:
12+
13+
```json
14+
{
15+
"name": "<service name>",
16+
"documents": {}
17+
}
18+
```

content/terms/reference/declaration.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
---
22
title: "Declaration format"
3-
weight: 4
43
---
54

65
# Terms declaration format reference
File renamed without changes.

0 commit comments

Comments
 (0)