Skip to content

Commit

Permalink
Split declarations maintenance how to
Browse files Browse the repository at this point in the history
  • Loading branch information
clementbiron committed Dec 18, 2024
1 parent 2c622fb commit 25a7b7f
Show file tree
Hide file tree
Showing 11 changed files with 52 additions and 40 deletions.
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Declarations maintenance"
weight: 3
weight: 6
---

# Declarations maintenance
Expand Down Expand Up @@ -88,40 +88,3 @@ export const removeSharesButton = [
},
];
```

## How to terminate a service

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:

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

```json
{
"name": "<service name>",
"documents": {}
}
```

## How to rename a service

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.

## How to get the `validUntil` date from an issue

1. Go to the open issue and scroll to the last action from `OTA-Bot` (comment or issue opening).

![]({{< relref "." >}}declarations-maintenance-ota-bot-comment.png)

Note that sometimes:

- the date is not quite precise, it can be written "last month"
![]({{< relref "." >}}declarations-maintenance-ota-bot-comment-last-month.png)
- the last comment may be the announcement of the reopening of the issue
![]({{< relref "." >}}declarations-maintenance-ota-bot-comment-reopened-issue.png)

2. On the date of this comment, right-click "inspect" to open your browser's code inspector.

3. The value to use as `validUntil` is the value of the `datetime` attribute from the `<relative-time>` element.

![]({{< relref "." >}}declarations-maintenance-inspector-open-get-datetime.png)
25 changes: 25 additions & 0 deletions content/terms/how-to/get-the-validUntil-date-from-an-issue.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
title: How to get the `validUntil`
linkTitle: Get the `validUntil` date
---

# How to get the `validUntil` date

## From a GitHub issue

1. Go to the open issue and scroll to the last action from `OTA-Bot` (comment or issue opening).

![]({{< relref "." >}}declarations-maintenance-ota-bot-comment.png)

Note that sometimes:

- the date is not quite precise, it can be written "last month"
![]({{< relref "." >}}declarations-maintenance-ota-bot-comment-last-month.png)
- the last comment may be the announcement of the reopening of the issue
![]({{< relref "." >}}declarations-maintenance-ota-bot-comment-reopened-issue.png)

2. On the date of this comment, right-click "inspect" to open your browser's code inspector.

3. The value to use as `validUntil` is the value of the `datetime` attribute from the `<relative-time>` element.

![]({{< relref "." >}}declarations-maintenance-inspector-open-get-datetime.png)
8 changes: 8 additions & 0 deletions content/terms/how-to/rename-a-service.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
title: How to rename a service
linkTitle: Rename a service
---

# How to rename a service

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.
18 changes: 18 additions & 0 deletions content/terms/how-to/terminate-a-service.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
title: How to terminate a service
linkTitle: Terminate a service
---

# How to terminate a service

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:

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

```json
{
"name": "<service name>",
"documents": {}
}
```
1 change: 0 additions & 1 deletion content/terms/reference/declaration.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
title: "Declaration format"
weight: 4
---

# Terms declaration format reference
Expand Down
File renamed without changes.
1 change: 0 additions & 1 deletion content/terms/tutorials/track.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
title: Track your first terms
weight: 1
---

# Track your first terms
Expand Down

0 comments on commit 25a7b7f

Please sign in to comment.