-
Notifications
You must be signed in to change notification settings - Fork 18
/
mkdocs.yml
151 lines (145 loc) · 7.86 KB
/
mkdocs.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
site_name: DSP-API
nav:
- Introduction:
- Overview: index.md
- What is DSP?: 01-introduction/what-is-dsp.md
- File Formats in DSP-API: 01-introduction/file-formats.md
- Standoff/RDF Text Markup: 01-introduction/standoff-rdf.md
- An Example Project: 01-introduction/example-project.md
- DSP Ontologies:
- Introduction: 02-dsp-ontologies/introduction.md
- The Knora Base Ontology: 02-dsp-ontologies/knora-base.md
- The SALSAH GUI Ontology: 02-dsp-ontologies/salsah-gui.md
- DSP-API Endpoints:
- DSP-API V2:
- Introduction: 03-endpoints/api-v2/introduction.md
- Authentication: 03-endpoints/api-v2/authentication.md
- Reading and Searching Resources: 03-endpoints/api-v2/reading-and-searching-resources.md
- Reading the User's Permissions on Resources and Values: 03-endpoints/api-v2/reading-user-permissions.md
- Getting Lists: 03-endpoints/api-v2/getting-lists.md
- Gravsearch - Virtual Graph Search: 03-endpoints/api-v2/query-language.md
- Creating and Editing Resources: 03-endpoints/api-v2/editing-resources.md
- Creating and Editing Values: 03-endpoints/api-v2/editing-values.md
- Querying, Creating, and Updating Ontologies: 03-endpoints/api-v2/ontology-information.md
- Textual Data in DSP-API:
- Overview: 03-endpoints/api-v2/text/overview.md
- Standard Standoff Markup: 03-endpoints/api-v2/text/standard-standoff.md
- Custom Standoff Mapping: 03-endpoints/api-v2/text/custom-standoff.md
- TEI XML: 03-endpoints/api-v2/text/tei-xml.md
- Permalinks: 03-endpoints/api-v2/permalinks.md
- IRIs: 03-endpoints/api-v2/knora-iris.md
- Admin API:
- Introduction: 03-endpoints/api-admin/introduction.md
- Overview: 03-endpoints/api-admin/overview.md
- Users Endpoint: 03-endpoints/api-admin/users.md
- Projects Endpoint: 03-endpoints/api-admin/projects.md
- Groups Endpoint: 03-endpoints/api-admin/groups.md
- Lists Endpoint: 03-endpoints/api-admin/lists.md
- Permissions Endpoint: 03-endpoints/api-admin/permissions.md
- Stores Endpoint: 03-endpoints/api-admin/stores.md
- OpenApi Documentation: 03-endpoints/api-admin/index.md
- Util API:
- Version: 03-endpoints/api-util/version.md
- Instrumentation API:
- Introduction: 03-endpoints/instrumentation/introduction.md
- Health Endpoint: 03-endpoints/instrumentation/health.md
- Metrics Endpoint: 03-endpoints/instrumentation/metrics.md
- Publishing and Deployment:
- Publishing: 04-publishing-deployment/publishing.md
- Configuration: 04-publishing-deployment/configuration.md
- DSP Internals:
- Design:
- Architectural Decision Records (ADR):
- 0001 Record Architectural Decisions: 05-internals/design/adr/ADR-0001-record-architecture-decisions.md
- 0002 Change Cache Service Manager from Akka-Actor to ZLayer: 05-internals/design/adr/ADR-0002-change-cache-service-manager-from-akka-actor-to-zlayer.md
- 0003 Change IIIF Service Manager and Sipi implementation to zlayer: 05-internals/design/adr/ADR-0003-change-iiif-service-manager-and-sipi-implementation-to-zlayer.md
- 0004 Change Triplestore Service Manager and Fuseki implementation to ZLayer: 05-internals/design/adr/ADR-0004-change-triplestore-service-manager-and-fuseki-implementation-to-zlayer.md
- 0005 Change ResponderManager to a simple case class: 05-internals/design/adr/ADR-0005-change-respondermanager-to-a-simple-case-class.md
- 0006 Gradually Replace Akka-HTTP with ZIO-HTTP: 05-internals/design/adr/ADR-0006-use-zio-http.md
- 0007 ZIO-fication of Responders: 05-internals/design/adr/ADR-0007-zio-fication-of-responders.md
- 0008 Replace Akka with Pekko: 05-internals/design/adr/ADR-0008-replace-akka-with-pekko.md
- DSP-API Design Principles:
- Design Overview: 05-internals/design/principles/design-overview.md
- Store Module: 05-internals/design/principles/store-module.md
- Triplestore Updates: 05-internals/design/principles/triplestore-updates.md
- Consistency Checking: 05-internals/design/principles/consistency-checking.md
- Authentication: 05-internals/design/principles/authentication.md
- RDF Processing API: 05-internals/design/principles/rdf-api.md
- DSP-API V2 Design:
- API v2 Design Overview: 05-internals/design/api-v2/overview.md
- Ontology Schemas: 05-internals/design/api-v2/ontology-schemas.md
- Smart IRIs: 05-internals/design/api-v2/smart-iris.md
- Content Wrappers: 05-internals/design/api-v2/content-wrappers.md
- How to Add an API v2 Route: 05-internals/design/api-v2/how-to-add-a-route.md
- JSON-LD Parsing and Formatting: 05-internals/design/api-v2/json-ld.md
- Ontology Management: 05-internals/design/api-v2/ontology-management.md
- DSP-API and Sipi: 05-internals/design/api-v2/sipi.md
- Gravsearch Design: 05-internals/design/api-v2/gravsearch.md
- Standoff Markup: 05-internals/design/api-v2/standoff.md
- Archival Resource Key (ARK): 05-internals/design/api-v2/ark.md
- SPARQL Query Design: 05-internals/design/api-v2/query-design.md
- Admin API Design: 05-internals/design/api-admin/administration.md
- DSP Domain:
- Domain Entities and Relations: 05-internals/design/domain/domain-entities-and-relations.md
- System Instances: 05-internals/design/domain/system-instances.md
- Class and Property Hierarchies: 05-internals/design/domain/class-and-property-hierarchies.md
- Development:
- Overview: 05-internals/development/overview.md
- Build and Running: 05-internals/development/building-and-running.md
- Setup Visual Studio Code for development of DSP-API: 05-internals/development/vscode-config.md
- Testing: 05-internals/development/testing.md
- Docker Cheat Sheet: 05-internals/development/docker-cheat-sheet.md
- Starting the DSP-Stack inside Docker Container: 05-internals/development/docker-compose.md
- Updating Repositories: 05-internals/development/updating-repositories.md
- Third-Party Dependencies: 05-internals/development/third-party.md
- SIPI:
- Overview: 06-sipi/index.md
- Interaction between Sipi and DSP-API: 06-sipi/sipi-and-dsp-api.md
- Lucene:
- Lucene Query Parser Syntax: 07-lucene/lucene-query-parser-syntax.md
- Frequently Asked Questions: 08-faq/index.md
- Release Notes:
- Changelog: 09-release-notes/index.md
- Migration Guides and Deprecations: 10-migration-guides/index.md
plugins:
- search
- git-revision-date-localized
- neoteroi.mkdocsoad:
use_pymdownx: true
theme:
name: material
logo: "assets/icons/logo_bw.svg"
favicon: "assets/icons/logo_bw.svg"
palette:
- scheme: default
toggle:
icon: material/brightness-7
name: Switch to dark mode
- scheme: slate
toggle:
icon: material/brightness-4
name: Switch to light mode
features:
# - navigation.tabs
- navigation.instant
- navigation.tracking
- navigation.top
- search.suggest
- version
extra_css:
- assets/css/theme.css
- assets/css/mkdocsoad-v1.0.2.css
markdown_extensions:
- admonition
- pymdownx.details
- pymdownx.superfences
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
- pymdownx.tasklist:
custom_checkbox: true
- pymdownx.tabbed:
alternate_style: true
- pymdownx.tilde