-
Notifications
You must be signed in to change notification settings - Fork 10
/
Copy pathmkdocs.yml
258 lines (255 loc) · 14.5 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
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
site_name: Gaffer Docs
repo_url: https://github.com/gchq/gaffer-doc
repo_name: gchq/gaffer-doc
edit_uri: edit/v2docs/docs/
copyright: <a href="https://www.nationalarchives.gov.uk/information-management/re-using-public-sector-information/uk-government-licensing-framework/crown-copyright/">Copyright © 2016-2023 Crown Copyright</a>
validation:
omitted_files: warn
absolute_links: warn
unrecognized_links: warn
anchors: warn
strict: true
markdown_extensions:
- admonition
- pymdownx.details
- pymdownx.highlight:
anchor_linenums: true
line_spans: __span
pygments_lang_class: true
- pymdownx.inlinehilite
- pymdownx.snippets
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
- pymdownx.tabbed:
alternate_style: true
- admonition
- pymdownx.details
- tables
- attr_list
- pymdownx.emoji:
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg
extra:
social:
- icon: fontawesome/brands/github
link: https://github.com/gchq/gaffer
name: Gaffer on GitHub
version:
provider: mike
plugins:
- search
- redirects:
redirect_maps:
'dev/docker.md': 'administration-guide/gaffer-deployment/gaffer-docker/gaffer-images.md'
'dev/kubernetes-guide/kubernetes.md': 'administration-guide/gaffer-deployment/kubernetes-guide/running-on-kubernetes.md'
'dev/ways-of-working.md': 'development-guide/ways-of-working.md'
'dev/components/operation.md': 'development-guide/project-structure/components/operation.md'
'dev/components/cache.md': 'development-guide/project-structure/components/cache.md'
'dev/components/graph.md': 'development-guide/project-structure/components/graph.md'
'dev/components/data.md': 'development-guide/project-structure/components/data.md'
'dev/components/store.md': 'development-guide/project-structure/components/store.md'
'dev/components/serialisation.md': 'development-guide/project-structure/components/serialisation.md'
'dev/components/libraries/sketches.md': 'development-guide/project-structure/components/libraries/sketches.md'
'dev/components/libraries/bitmap.md': 'development-guide/project-structure/components/libraries/bitmap.md'
'dev/components/libraries/time.md': 'development-guide/project-structure/components/libraries/time.md'
'dev/components/libraries/flink.md': 'development-guide/project-structure/components/libraries/flink.md'
'dev/components/libraries/spark.md': 'development-guide/project-structure/components/libraries/spark.md'
'dev/components/integration-test.md': 'development-guide/project-structure/components/integration-test.md'
'dev/components/spring-rest.md': 'development-guide/project-structure/components/spring-rest.md'
'dev/components/core-rest.md': 'development-guide/project-structure/components/core-rest.md'
'dev/components/accumulo-store.md': 'development-guide/project-structure/components/accumulo-store.md'
'reference/stores-guide/stores.md': 'administration-guide/gaffer-stores/store-guide.md'
'reference/stores-guide/map.md': 'administration-guide/gaffer-stores/map-store.md'
'reference/stores-guide/proxy.md': 'administration-guide/gaffer-stores/proxy-store.md'
'reference/stores-guide/federated.md': 'administration-guide/gaffer-stores/federated-store.md'
'reference/stores-guide/accumulo.md': 'administration-guide/gaffer-stores/accumulo-store.md'
'getting-started/basics.md': 'user-guide/introduction.md'
'getting-started/guide/cardinality.md': 'user-guide/gaffer-basics/what-is-cardinality.md'
'getting-started/quickstart.md': 'administration-guide/gaffer-deployment/quickstart.md'
'getting-started/guide/guide.md': 'user-guide/introduction.md'
- offline
- privacy
nav:
- Home: 'index.md'
- User Guide:
- 'Introduction': 'user-guide/introduction.md'
- Gaffer Basics:
- 'What is a Graph?': 'user-guide/gaffer-basics/what-is-a-graph.md'
- 'What is Gaffer?': 'user-guide/gaffer-basics/what-is-gaffer.md'
- 'What is JSON?': 'user-guide/gaffer-basics/what-is-json.md'
- 'What is Python?': 'user-guide/gaffer-basics/what-is-python.md'
- 'What is Cardinality?': 'user-guide/gaffer-basics/what-is-cardinality.md'
- 'What is Aggregation?': 'user-guide/gaffer-basics/what-is-aggregation.md'
- 'Graph Schema': 'user-guide/schema.md'
- Available APIs:
- 'Spring REST': 'user-guide/apis/rest-api.md'
- 'Python (gafferpy)': 'user-guide/apis/python-api.md'
- 'Java': 'user-guide/apis/java-api.md'
- 'Gremlin (GafferPop)': 'user-guide/apis/gremlin-api.md'
- 'openCypher': 'user-guide/apis/opencypher.md'
- Querying:
- Gaffer Query Syntax:
- 'Operations': 'user-guide/query/gaffer-syntax/operations.md'
- 'Filtering Data': 'user-guide/query/gaffer-syntax/filtering.md'
- 'FAQs': 'user-guide/query/gaffer-syntax/faqs.md'
- Import/Export:
- 'Using CSV Data': 'user-guide/query/gaffer-syntax/import-export/csv.md'
- Gremlin:
- 'Gremlin in Gaffer': 'user-guide/query/gremlin/gremlin.md'
- 'Features': 'user-guide/query/gremlin/custom-features.md'
- 'Limitations': 'user-guide/query/gremlin/gremlin-limits.md'
- 'openCypher': 'user-guide/query/opencypher.md'
- Developer Guide:
- 'Introduction': 'development-guide/introduction.md'
- 'Ways of Working': 'development-guide/ways-of-working.md'
- 'Remote Coding Environments': 'development-guide/remote-coding-environments.md'
- 'Extending Gaffer': 'development-guide/extending-gaffer.md'
- 'Sketches Custom Deserialisation': 'development-guide/rest-api-sketches.md'
- Project Structure:
- Components:
- 'Components/Maven Modules': 'development-guide/project-structure/components/components.md'
- 'Cache': 'development-guide/project-structure/components/cache.md'
- 'Data': 'development-guide/project-structure/components/data.md'
- 'Graph': 'development-guide/project-structure/components/graph.md'
- 'Store': 'development-guide/project-structure/components/store.md'
- 'User': 'development-guide/project-structure/components/user.md'
- 'Operation': 'development-guide/project-structure/components/operation.md'
- 'Serialisation': 'development-guide/project-structure/components/serialisation.md'
- 'Integration Tests': 'development-guide/project-structure/components/integration-test.md'
- 'Core REST': 'development-guide/project-structure/components/core-rest.md'
- 'Spring REST': 'development-guide/project-structure/components/spring-rest.md'
- 'Accumulo Store': 'development-guide/project-structure/components/accumulo-store.md'
- Libraries:
- development-guide/project-structure/components/libraries/bitmap.md
- development-guide/project-structure/components/libraries/flink.md
- development-guide/project-structure/components/libraries/sketches.md
- development-guide/project-structure/components/libraries/spark.md
- development-guide/project-structure/components/libraries/time.md
- Maven Dependencies:
- 'Managing Dependencies': 'development-guide/project-structure/maven-dependencies/managing-dependencies.md'
- Example Deployment:
- 'Project Setup': 'development-guide/example-deployment/project-setup.md'
- 'Writing the Schema': 'development-guide/example-deployment/writing-the-schema.md'
- 'Running the Deployment': 'development-guide/example-deployment/running-the-deployment.md'
- 'Using the API': 'development-guide/example-deployment/using-the-api.md'
- Administration Guide:
- 'Introduction': 'administration-guide/introduction.md'
- 'Quickstart': 'administration-guide/gaffer-deployment/quickstart.md'
- Deployment:
- Docker:
- 'Gaffer Images': 'administration-guide/gaffer-deployment/gaffer-docker/gaffer-images.md'
- 'How to Deploy with Accumulo on Docker': 'administration-guide/gaffer-deployment/gaffer-docker/how-to-run.md'
- Kubernetes:
- 'Running Gaffer on Kubernetes': 'administration-guide/gaffer-deployment/kubernetes-guide/running-on-kubernetes.md'
- 'Creating a Simple Deployment': 'administration-guide/gaffer-deployment/kubernetes-guide/simple-deployment.md'
- 'Configuring Gaffer with Helm': 'administration-guide/gaffer-deployment/kubernetes-guide/helm-configuration.md'
- 'Gremlin': 'administration-guide/gaffer-deployment/gremlin.md'
- Store Types:
- 'Store Guide': 'administration-guide/gaffer-stores/store-guide.md'
- 'Accumulo Store': 'administration-guide/gaffer-stores/accumulo-store.md'
- 'Federated Store': 'administration-guide/gaffer-stores/federated-store.md'
- Simple Federated Store:
- 'Configuration': 'administration-guide/gaffer-stores/simple-federated/configuration.md'
- 'Access Control': 'administration-guide/gaffer-stores/simple-federated/access-control.md'
- 'Additional Information': 'administration-guide/gaffer-stores/simple-federated/additional-info.md'
- 'Map Store': 'administration-guide/gaffer-stores/map-store.md'
- 'Proxy Store': 'administration-guide/gaffer-stores/proxy-store.md'
- Configuration:
- 'Graph Configuration': 'administration-guide/gaffer-config/config.md'
- 'Schema': 'administration-guide/gaffer-config/schema.md'
- 'Changing Accumulo Passwords': 'administration-guide/gaffer-config/change-accumulo-passwords.md'
- Aggregation Guide:
- 'Overview': 'administration-guide/aggregation/overview.md'
- 'Ingest Example': 'administration-guide/aggregation/ingest-example.md'
- 'Named Operations': 'administration-guide/named-operations.md'
- 'Named Views': 'administration-guide/named-views.md'
- 'Operation Score': 'administration-guide/operation-score.md'
- 'Job Tracker': 'administration-guide/job-tracker.md'
- 'Delete Operation': 'administration-guide/delete-elements.md'
- Security:
- 'Security Guide': 'administration-guide/security/security-guide.md'
- 'User Control': 'administration-guide/security/user-control.md'
- 'Accumulo Kerberos': 'administration-guide/security/accumulo-kerberos.md'
- Change Notes:
- 'Changelist':
- '2.1.0 Changes': 'change-notes/changelist/v2.1.0-changes.md'
- '2.0.0 Changes': 'change-notes/changelist/v2-changes.md'
- 'Migrating from V1 to V2':
- 'Deprecations': 'change-notes/migrating-from-v1-to-v2/deprecations.md'
- 'Dependencies': 'change-notes/migrating-from-v1-to-v2/dependencies.md'
- 'Accumulo Migration': 'change-notes/migrating-from-v1-to-v2/accumulo-migration.md'
- 'Federation Changes': 'change-notes/migrating-from-v1-to-v2/federation-changes.md'
- 'Log4j in Gaffer': 'change-notes/migrating-from-v1-to-v2/log4j.md'
- Reference:
- 'Introduction': 'reference/intro.md'
- 'Glossary': 'reference/glossary.md'
- 'Javadoc': 'reference/javadoc.md'
- Properties:
- 'Properties Guide': 'reference/properties-guide/properties.md'
- 'Basic Properties': 'reference/properties-guide/basic.md'
- 'Advanced Properties': 'reference/properties-guide/advanced.md'
- 'Type Properties': 'reference/properties-guide/type.md'
- 'Map & Set Properties': 'reference/properties-guide/map-set.md'
- Predicates:
- 'Predicates Guide': 'reference/predicates-guide/predicates.md'
- 'Gaffer Predicates': 'reference/predicates-guide/gaffer-predicates.md'
- 'Koryphe Predicates': 'reference/predicates-guide/koryphe-predicates.md'
- 'Binary Operators':
- 'Binary Operators Guide': 'reference/binary-operators-guide/binary-operators.md'
- 'Koryphe Operators Guide': 'reference/binary-operators-guide/koryphe-operators.md'
- Functions:
- 'Functions Guide': 'reference/functions-guide/functions.md'
- 'Gaffer Functions': 'reference/functions-guide/gaffer-functions.md'
- 'Koryphe Functions': 'reference/functions-guide/koryphe-functions.md'
- Operations:
- 'Operations Guide': 'reference/operations-guide/operations.md'
- 'Core Operations': 'reference/operations-guide/core.md'
- 'Join Operation': 'reference/operations-guide/join.md'
- 'Get Operations': 'reference/operations-guide/get.md'
- 'Control Flow Operations': 'reference/operations-guide/flow.md'
- 'Job Operations': 'reference/operations-guide/job.md'
- 'Named Operations': 'reference/operations-guide/named.md'
- 'Export Operations': 'reference/operations-guide/export.md'
- 'Generate Operations': 'reference/operations-guide/generate.md'
- 'Federated Operation': 'reference/operations-guide/federated-operation.md'
- 'Flink Operations': 'reference/operations-guide/flink.md'
- 'HDFS Operations': 'reference/operations-guide/hdfs.md'
- 'Accumulo Operations': 'reference/operations-guide/accumulo.md'
- 'Spark Operations': 'reference/operations-guide/spark.md'
- 'Proxy Operations': 'reference/operations-guide/proxy.md'
- 'Misc Operations': 'reference/operations-guide/misc.md'
- Endpoints:
- 'Endpoints Guide': 'reference/endpoints-guide/endpoints.md'
- Gremlin:
- 'Gaffer Options': 'reference/gremlin-guide/gaffer-options.md'
- 'Custom Predicates': 'reference/gremlin-guide/custom-predicates.md'
- 'Custom Functions': 'reference/gremlin-guide/custom-functions.md'
theme:
name: material
logo: assets/icon.svg
favicon: assets/logo.svg
icon:
repo: fontawesome/brands/github
features:
- navigation.tabs
- navigation.top
- content.action.edit
- content.code.annotate
- content.code.copy
palette:
- media: "(prefers-color-scheme: light)"
scheme: default
primary: teal
toggle: &todark
icon: material/weather-night
name: Switch to dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
primary: teal
toggle: &tolight
icon: material/weather-sunny
name: Switch to light mode
custom_dir: docs/home_page_override/