You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: content/_index.md
+15-14Lines changed: 15 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,7 +6,7 @@ weight: 1
6
6
7
7
# Open Terms Archive documentation
8
8
9
-
Open Terms Archive is a decentralised system that tracks collections of services' terms across multiple servers. Each collection operates its own API, and the Federation API unifies search and discovery across collections, fostering collaboration with external applications.
9
+
Open Terms Archive is a decentralised system that tracks collections of services' terms across multiple servers. Each collection exposes the data it collects through datasets and through its own API. The Federation API unifies search and discovery across collections.
10
10
11
11
## Required minimal terminology
12
12
@@ -20,19 +20,20 @@ Before diving into the details, let's first understand the essential terminology
20
20
21
21
## Documentation structure
22
22
23
-
In this documentation you can find the following kind of content to support users at different levels:
23
+
This documentation follows the [Diátaxis](https://diataxis.fr) approach and structures content in different categories:
24
24
25
-
-**Tutorials:** Step-by-step learning guides that help beginners get started with Open Terms Archive, providing foundational knowledge and hands-on experience.
26
-
-**How-to guides:** Task-focused instructions that help experienced users accomplish specific goals efficiently and effectively.
27
-
-**Reference:** Comprehensive technical documentation detailing system components, configuration options, and specifications for advanced users.
25
+
-**Tutorials:** step-by-step learning guides that help beginners get started with Open Terms Archive, providing foundational knowledge and hands-on experience.
26
+
-**How-to guides:** task-focused instructions that help experienced users accomplish specific goals efficiently and effectively.
27
+
-**Reference:** comprehensive technical documentation detailing configuration options and specifications for advanced users.
28
+
-**Explanations:** background knowledge that enables understanding the constraints and how choices that are made.
28
29
29
-
##Main contents
30
+
### Table of contents
30
31
31
-
-**Analysis:**Provides guidance on how to analyze terms changes, from navigating through the history of tracked documents to publishing memos about significant changes, along with copywriting guidelines for creating analysis content.
32
-
-**Community:**Provides information on how to join and participate in the Open Terms Archive community.
33
-
-**Terms:**Provides guidance on tracking and maintaining terms declarations, reference documentation for declaration formats, and guidelines for selecting selectors and reviewing contributions.
34
-
-**Collections:**Provides guidance on creating and managing collections of tracked terms, creating repositories and defining metadata, and detailed reference documentation for configuration options, environment variables, governance roles, and collection metadata formats.
35
-
-**Federation:**Explains the benefits of joining the Open Terms Archive federation, and the criteria that collections must meet to be part of the federated ecosystem.
36
-
-**Deployment:**Guides to deploy a collection.
37
-
-**Programmatic access:**Provides documentation for programmatically interacting with Open Terms Archive.
38
-
-**Concepts and principles:**Explains the main conceptsand terminology of Open Terms Archive and fundamental design principles.
32
+
-**Analysis:** guidance on how to analyze terms changes, from navigating through the history of tracked documents to publishing memos about significant changes.
33
+
-**Community:** information on how to participate in the Open Terms Archive community.
34
+
-**Terms:** guidance on tracking and maintaining terms declarations.
35
+
-**Collections:** guidance on creating and managing collections of tracked terms.
36
+
-**Federation:**constraints and benefits of joining the Open Terms Archive federation.
37
+
-**Deployment:**guidance on operating an Open Terms Archive instance.
38
+
-**Programmatic access:** documentation on the engine CLI and APIs.
39
+
-**Concepts and principles:** main concepts, terminology and fundamental design principles of Open Terms Archive.
0 commit comments