-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Split declarations maintenance how to
- Loading branch information
1 parent
2c622fb
commit 25a7b7f
Showing
11 changed files
with
52 additions
and
40 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
25 changes: 25 additions & 0 deletions
25
content/terms/how-to/get-the-validUntil-date-from-an-issue.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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": {} | ||
} | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,6 +1,5 @@ | ||
--- | ||
title: "Declaration format" | ||
weight: 4 | ||
--- | ||
|
||
# Terms declaration format reference | ||
|
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 | ||
|