Skip to content

Commit

Permalink
Improve content architecture
Browse files Browse the repository at this point in the history
  • Loading branch information
clementbiron committed Jun 13, 2024
1 parent ca96e7f commit 6abd3ba
Show file tree
Hide file tree
Showing 8 changed files with 38 additions and 30 deletions.
2 changes: 1 addition & 1 deletion content/collections/create.en.md
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,7 @@ Create the versions repository by using the [`demo-versions` repository](https:/
#### Fill the “About” section

- Set the description: “Terms versions for `<collection_name>`. Maintained by `<maintainer>`.”
- Set website to `{{< ref "terms/navigate-trough-versions-history" >}}`
- Set website to `{{< ref "terms/how-to-navigate-history" >}}`
- Add the following tags: `terms-of-service`, `terms-of-service-agreements`, `terms-and-conditions`, `open-terms-archive`.
- Uncheck “Packages”.
- Uncheck “Deployments”.
Expand Down
14 changes: 0 additions & 14 deletions content/guidelines/declaring.en.md
Original file line number Diff line number Diff line change
Expand Up @@ -196,17 +196,3 @@ You can only use our copyrights or [trademarks (or any similar marks)](https://l
#### Solution

Write a filter in the declaration.

- - -

## Using the graphical contribution interface

### Blank page when contacting support

While using the graphical user interface for contribution, you may come across a blank page when trying to contact the team.

This may be caused by the lack of a mail program being set up in your browser.

#### Solution

If you use Gmail, for example, [these instructions](https://support.google.com/chrome/thread/57026170/how-to-add-gmail-as-default-mailto-handler) explain how to add Gmail as the default `mailto` handler in Chrome. Try following them and trying again.
4 changes: 2 additions & 2 deletions content/guidelines/reviewing.en.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ The pull request created will consist of fewer checks than those that add declar

For pull requests that update declarations, you should focus should be on two things: history file and declaration.

- **History file:** The history file is a JSON file that keeps track of a service declaration changes. It contains a `validUntil` property that specifies the date a specific version of a service declaration was last effective. You have to confirm that this date is the same as the date in the issue opened for the declaration when the bot couldn't track it for the first time. This issue is usually included in the pull request message. The history file is updated with every `update` pull request. You can find more information about the history file [here]({{< relref "terms/maintaining" >}}).
- **History file:** The history file is a JSON file that keeps track of a service declaration changes. It contains a `validUntil` property that specifies the date a specific version of a service declaration was last effective. You have to confirm that this date is the same as the date in the issue opened for the declaration when the bot couldn't track it for the first time. This issue is usually included in the pull request message. The history file is updated with every `update` pull request. You can find more information about the history file [here]({{< relref "terms/declarations-maintenance" >}}).
- **Declaration:** for `update` pull requests, you only look at the selectors to make sure they are **simple** and also verify the **generated version** is ok.

### Step-by-step Review Guide
Expand All @@ -83,7 +83,7 @@ For pull requests that update declarations, you should focus should be on two th
5. Compare it with the `validUntil` property in the history file under the `Files changes` section of the pull request. If the dates are the same, proceed to approve the pull request.
6. Merge the contribution.

You can read more about maintaining declarations from the [official documentation]({{< relref "terms/maintaining" >}}).
You can read more about maintaining declarations from the [official documentation]({{< relref "terms/declarations-maintenance" >}}).

## When to Make Changes to a Contribution

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: "Declarations maintenance"
weight: 3
---

# Maintaining declarations
# Declarations maintenance

All parts of a **terms** **declaration** (web location, selection, noise removal, distribution across multiple documents…) can change over time. The process of updating these elements to enable continued **tracking** is called **maintenance**. Without it, **terms** can become:

Expand Down
7 changes: 0 additions & 7 deletions content/terms/how-to-add-terms-using-the-contribution-tool.md

This file was deleted.

Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
title: "How to add terms with the graphical contribution interface"
---

# How to add terms with the graphical contribution interface

## Screencast

Learn how add terms with the graphical contribution interface in this 6 minutes video.

{{< video src="https://cloud.opentermsarchive.org/index.php/s/7QZgcDgLLQSkzNW/download/how-to-add-terms-using-the-contribution-tool.mp4#t=0.1" >}}

## Manual

### Blank page when contacting support

While using the graphical user interface for contribution, you may come across a blank page when trying to contact the team.

This may be caused by the lack of a mail program being set up in your browser.

#### Solution

If you use Gmail, for example, [these instructions](https://support.google.com/chrome/thread/57026170/how-to-add-gmail-as-default-mailto-handler) explain how to add Gmail as the default `mailto` handler in Chrome. Try following them and trying again.
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: "How to be notified of terms changes"
aliases: /subscribe-rss/
---

# How to subscribe to terms changes
# How to be notified of terms changes

An RSS feed is a type of web page that contains information about the latest content published by a website, such as the date of publication and the address where you can view it. When this resource is updated, a feed reader app automatically notifies you and you can see the update. You can receive notification for a specific service or document by subscribing to RSS feeds.

Expand All @@ -13,7 +13,7 @@ An RSS feed is a type of web page that contains information about the latest con

To find out the address of the RSS feed you want to subscribe to:

1. [Navigate]({{< relref "terms/navigate-trough-versions-history" >}}) to the page with the history of changes you are interested in.
1. [Navigate]({{< relref "terms/how-to-navigate-history" >}}) to the page with the history of changes you are interested in.
- For example, for the GitHub Privacy Policy of the Demo instance, this would be [this page](https://github.com/OpenTermsArchive/demo-versions/commits/main/GitHub/Privacy%20Policy.md).
2. Copy the address of that page from your browser’s address bar.
- For example, for the GitHub Privacy Policy of the Demo instance, this would be `https://github.com/OpenTermsArchive/demo-versions/commits/main/GitHub/Privacy%20Policy.md`.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,15 @@ weight: 1
aliases: /navigate-history/
---

# Navigate through versions history
# How to navigate history

{{< video src="https://cloud.opentermsarchive.org/index.php/s/DJ4rqJi5M8fAecL/download/how-to-navigate-through-versions-history-in-open-terms-archive.mp4" >}}
## Screencast

Learn how to navigate through versions history in this 4 minutes video, or scroll below for the textual version.

{{< video src="https://cloud.opentermsarchive.org/index.php/s/DJ4rqJi5M8fAecL/download/how-to-navigate-through-versions-history-in-open-terms-archive.mp4#t=0.1" >}}

## Manual

Every collection offers a public database of versions they recorded.

Expand Down Expand Up @@ -38,7 +44,7 @@ For this guide, we will use the example of the Demo collection. The terms of thi

- - -

## Notes
### Notes

- For long documents, unchanged paragraphs will not be displayed by default. You can manually make them appear by clicking on the small arrows just above or just below the displayed paragraphs:

Expand Down

0 comments on commit 6abd3ba

Please sign in to comment.