forked from inveniosoftware/docs-invenio-rdm
-
Notifications
You must be signed in to change notification settings - Fork 0
/
mkdocs.yml
259 lines (252 loc) · 11.6 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
259
# Project information
site_name: "Turn-key research data management repository"
site_url: "https://inveniordm.docs.cern.ch"
# Repository
repo_url: "https://github.com/inveniosoftware/docs-invenio-rdm"
# Copyright
copyright: "Copyright © 2019-2024 CERN, Northwestern University and contributors."
# Configuration
theme:
name: material
custom_dir: theme
palette:
# Palette toggle for light mode
- media: "(prefers-color-scheme: light)"
scheme: default
primary: custom
accent: custom
extra_css:
- stylesheets/extra.css
toggle:
icon: material/brightness-7
name: Switch to dark mode
# Palette toggle for dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
primary: black
accent: orange
toggle:
accent: orange
icon: material/brightness-4
name: Switch to light mode
font: false
logo: "images/logo-rdm.png"
favicon: "images/favicon.svg"
features:
- navigation.tabs
- navigation.footer
- content.code.copy
nav:
- Home: "index.md"
- Features:
- Overview: "features/index.md"
- Beautiful UX: "features/ux.md"
- Highly scalable: "features/scalable.md"
- Customizable: "features/customization.md"
- Interoperable: "features/interoperable.md"
- Powerful: "features/powerful.md"
- Secure: "features/secure.md"
- Features walk-through:
- Features overview: "features/features-walk-through/index.md"
- Site banners: "features/features-walk-through/banners.md"
- Install:
- Quick start: "install/index.md"
- System requirements: "install/requirements.md"
- Install CLI: "install/cli.md"
- Scaffold: "install/scaffold.md"
- Build, setup & run: "install/build-setup-run.md"
- Configure: "install/configuration.md"
- Use: "install/run.md"
- Migrate: "install/migrate.md"
- Destroy: "install/destroy.md"
- Troubleshooting: "install/troubleshoot.md"
- Customize:
- Overview: "customize/index.md"
- Look-and-feel:
- Overview: "customize/look-and-feel/index.md"
- Change logo: "customize/look-and-feel/logo.md"
- Change templates: "customize/look-and-feel/templates.md"
- Change theme: "customize/look-and-feel/theme.md"
- Change font: "customize/look-and-feel/font.md"
- Authentication: "customize/authentication.md"
- Sending emails: "customize/emails.md"
- Search:
- Change facets/sorting: "customize/search.md"
- Vocabularies:
- Overview: "customize/vocabularies/index.md"
- Resource types: "customize/vocabularies/resource_types.md"
- Affiliations: "customize/vocabularies/affiliations.md"
- Names: "customize/vocabularies/names.md"
- Funding: "customize/vocabularies/funding.md"
- Subjects: "customize/vocabularies/subjects.md"
- Users: "customize/vocabularies/users.md"
- Metadata:
- Custom fields:
- Add fields to records: "customize/metadata/custom_fields/records.md"
- Add fields to communities: "customize/metadata/custom_fields/communities.md"
- Record landing page: "customize/record_landing_page.md"
- Static pages: "customize/static_pages.md"
- DOI registration: "customize/dois.md"
- Other PIDs integrations:
- DNB URNs: "customize/other-pids/urns.md"
- Storage: "customize/s3.md"
- Upload Limits: "customize/upload_limits.md"
- Metadata-only records: "customize/metadata_only.md"
- Logging: "customize/Logging.md"
- Internationalisation (i18n) and Localisation (l10n): "customize/i18n-and-l10n.md"
- Develop:
- Overview: "develop/index.md"
- Getting started:
- Source code: "develop/getting-started/source-code.md"
- Package development: "develop/getting-started/package-development.md"
- Instance development: "develop/getting-started/instance-development.md"
- Debugging: "develop/getting-started/debugging.md"
- Coding style: "develop/getting-started/code-style.md"
- Virtual environments: "develop/getting-started/virtualenvs.md"
- Getting help: "develop/getting-started/help.md"
- Development process: develop/process.md
- Best practices:
- Accessibility (a11y): develop/best-practices/accessibility.md
- Commits, PRs & reviews: develop/best-practices/commits.md
- CSS/JavaScript: develop/best-practices/css-js.md
- React: develop/best-practices/react.md
- User interface: develop/best-practices/ui.md
- Topic guides:
# - Building REST APIs: develop/topics/rest.md
- Building resources: develop/topics/resource.md
- Building services: develop/topics/service.md
# - Building records: develop/topics/record.md
# - Building system fields: develop/topics/systemfield.md
- Building serializers: develop/topics/serializers.md
- Grouping atomic operations: develop/topics/uow.md
- Sanitize input data: develop/topics/validation.md
- Theming: develop/topics/theming.md
- Administration panel: develop/topics/administration_panel.md
- How-to guides:
- Translation (i18n): develop/howtos/i18n.md
- Create a new custom field: develop/howtos/custom_fields.md
- Create custom code and views: develop/howtos/custom_code.md
- Add JavaScript: "develop/howtos/add_javascript.md"
- Override UI React components: develop/howtos/override_components.md
- Create search terms mappings: develop/howtos/search_terms_migration.md
- Create a database migration: develop/howtos/alembic.md
- Fix a vulnerability: develop/howtos/security-fix.md
- Test emails locally: develop/howtos/dev_email.md
- Migrate legacy routes: develop/howtos/route_migration.md
- Back up search indices: develop/howtos/backup_search_indices.md
- Restrict access to pages: develop/howtos/restrict_access.md
- Architecture:
- Introduction: develop/architecture/index.md
- Infrastructure: develop/architecture/infrastructure.md
- Software: develop/architecture/software.md
- Runtime: develop/architecture/runtime.md
- Requests: develop/architecture/requests.md
- Communities: develop/architecture/communities.md
- Records: develop/architecture/records.md
- Event handling: develop/architecture/event_handling.md
- Recommended reading: develop/architecture/reading.md
- Concepts:
- Optimistic concurrency control: develop/concepts/concurrency-control.md
- Database transaction management: develop/concepts/transactions.md
- Deploy: deploy/index.md
- Reference:
- Overview: reference/index.md
- CLI: reference/cli.md
- Configuration: reference/configuration.md
- Metadata: reference/metadata.md
- OAI-PMH: reference/oai_pmh.md
- Export formats: reference/export_formats.md
- REST API:
- Overview: "reference/rest_api_index.md"
- Quickstart: "reference/rest_api_quickstart.md"
- Communities: "reference/rest_api_communities.md"
- Drafts and Records: "reference/rest_api_drafts_records.md"
- Groups: "reference/rest_api_groups.md"
- Members: "reference/rest_api_members.md"
- Requests: "reference/rest_api_requests.md"
- Users: "reference/rest_api_users.md"
- Reviews: "reference/rest_api_reviews.md"
- Vocabularies: "reference/rest_api_vocabularies.md"
- Names: "reference/rest_api_names.md"
- Funders: "reference/rest_api_funders.md"
- Awards: "reference/rest_api_awards.md"
- OAI-PMH Sets: "reference/rest_api_oaipmh_sets.md"
- Statistics: "reference/rest_api_statistics.md"
- Custom fields:
- UI widgets: "reference/custom_fields/widgets.md"
- Fields list: "reference/custom_fields/fields_list.md"
- Administration:
- Reference: "reference/administration_reference.md"
- File storage: "reference/file_storage.md"
- Usage statistics: "reference/statistics.md"
- Releases:
- Overview: releases/index.md
- Maintenance policy: releases/maintenance-policy.md
- Security policy: releases/security-policy.md
- Versions:
- Version v11.0.0: releases/versions/version-v11.0.0.md
- Version v10.1.0: releases/versions/version-v10.1.0.md
- Version v10.0.0: releases/versions/version-v10.0.0.md
- Version v9.1.0: releases/versions/version-v9.1.0.md
- Version v9.0.0: releases/versions/version-v9.0.0.md
- Version v8.0.0: releases/versions/version-v8.0.0.md
- Version v7.0.0: releases/versions/version-v7.0.0.md
- Version v6.0.5: releases/versions/version-v6.0.5.md
- Version v6.0.0: releases/versions/version-v6.0.0.md
- Version v5.0.0: releases/versions/version-v5.0.0.md
- Version v4.0.0: releases/versions/version-v4.0.0.md
- Version v3.0.0: releases/versions/version-v3.0.0.md
- Version v2.0.0: releases/versions/version-v2.0.0.md
- Version v1.0.0: releases/versions/version-v1.0.0.md
- Upgrade guide:
- Upgrade policy: releases/upgrading/index.md
- Upgrade from v10 to v11: releases/upgrading/upgrade-v11.0.md
- Upgrade from v9 to v10: releases/upgrading/upgrade-v10.0.md
- Migrate Docker images: releases/upgrading/migrate-docker-images.md
- Migrate v9 to OpenSearch: releases/upgrading/migrate-opensearch-v9.md
- Upgrade from v8 to v9: releases/upgrading/upgrade-v9.0.md
- Upgrade from v7 to v8: releases/upgrading/upgrade-v8.0.md
- Upgrade from v6 to v7: releases/upgrading/upgrade-v7.0.md
- Upgrade from v6.0.x to v6.0.5: releases/upgrading/upgrade-v6.0.5.md
- Upgrade from v4 to v6: releases/upgrading/upgrade-v6.0.md
- Upgrade from v3 to v4: releases/upgrading/upgrade-v4.0.md
- Upgrade from v2 to v3: releases/upgrading/upgrade-v3.0.md
- Upgrade from v1 to v2: releases/upgrading/upgrade-v2.0.md
- Temporary versions:
- Version v12.0.0b1: releases/temporary-versions/version-v12.0.0b1.md
- Upgrade from v11 to v12.0.0b1: releases/temporary-versions/upgrade-v12.0.0b1.md
- Maintainers:
- Overview: maintenance/index.md
- Newcomers: maintenance/newcomers.md
- Sprintboard workflow: maintenance/board-workflow.md
- Community PR board: maintenance/pr-community-board.md
- Release management: maintenance/release-management.md
- Modules on GitHub: maintenance/modules.md
- Branch management: maintenance/branch-management.md
- Demo site & docs: maintenance/demosite.md
- Docker images: maintenance/docker-images.md
- RFCs: maintenance/rfcs.md
- Writing documentation: maintenance/documentation.md
- Onboard & Contribute:
- Overview: contribute/index.md
- Onboarding: contribute/onboarding.md
- Code of conduct: contribute/code-of-conduct.md
- Copyright policy: contribute/copyright-policy.md
- Roadmap: contribute/roadmap.md
- Translators guide: contribute/translators-guide.md
# Customization
extra:
social:
- icon: fontawesome/brands/github
link: https://github.com/inveniosoftware
extra_css:
- stylesheets/extra.css
# Extensions
markdown_extensions:
- admonition
- attr_list
- pymdownx.highlight
- pymdownx.superfences
- pymdownx.critic
- toc:
permalink: true