-
Notifications
You must be signed in to change notification settings - Fork 7
/
antora.yml
85 lines (69 loc) · 4.67 KB
/
antora.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
name: ocis
title: Infinite Scale Documentation
version: 'next'
start_page: ROOT:index.adoc
nav:
- modules/ROOT/partials/nav.adoc
asciidoc:
attributes:
# with antora 3.2, there will be new attributes `antora-component-version` and `antora-component-name`
# the ones used below need to be replaced when antora has been updated to 3.2
# https://gitlab.com/antora/antora/-/merge_requests/1048/diffs
latest-ocis-version: {page-component-version} # do not change, this is the value of the version key
previous-ocis-version: {page-component-version} # do not change, this is the value of the version key
# must be removed when antora 3.2 has been updated, because this is then an intrinsic attribute
# the branched value is the value for the production release like '7.0.0'
antora-component-version: 'next'
# used to define the include path for services without trailing /
# note that any changes of this path also need adjustment in
# https://github.com/owncloud/ocis-charts/tree/master/charts/ocis/docs
s-path: 'deployment/services/s-list'
# note that service_url_component is used for services ONLY
# service_url_component will be used to assemble the url for services to include content (tables) sourced from the ocis repo.
service_url_component: 'docs' # docs for master or for stable, like docs-stable-5.0
# defines the url path component when accessing the ocis repo for versioned data includes
ocis_repo_url_component: 'master' # master for master or for stable, like stable-5.0
# service_tab_text will be used as tab text shown for the tables in services only
# note when literally changing the word 'master' to something else, you also must adapt 'env-and-yaml.adoc'.
# this does not apply to branched releases using semver, only to the master branch!
service_tab_text: 'master' # latest stable including patch releases like 5.0.0
# note that compose_url_component is used for compose examples and for the EULA ONLY
# compose_url_component will be used to assemble the url (tag) accessing the link for the services (tag)
compose_url_component: 'master' # latest stable including patch releases like v5.0.0 (note the v ! as it is tagged)
# compose_tab_text will be used as tab text for examples and all other stuff but not services
compose_tab_text: 'master' # latest stable including patch releases like 5.0.0
# use this attribute to define the branch name for git clone
# the value is usually identical to compose_tab_text, but it should be separable to be independent
# note that you must define a value and not an attribute from above
compose_git_name: 'master' # latest stable including patch releases like 5.0.0 (must be without v !)
# this is the first part of the name for envvars between major versions that will be added or removed
# example for full name: 4.0.0-5.0.0-added.adoc or 4.0.0-5.0.0-removed.adoc
env_var_delta_name: '4.0.0-5.0.0'
# helm_tab_x will be used to assemble the url (tag) accessing the raw content for helm charts (tag)
# note that tab 2 always contains the actual release and tab 3 the former
helm_tab_1: 'master'
helm_tab_2: 'v0.5.0'
helm_tab_3: 'v0.4.0'
# helm_tab_x_tab_text will be used as tab text shown for tab_x
# note that tab 2 always contains the actual release and tab 3 the former
helm_tab_1_tab_text: 'latest'
helm_tab_2_tab_text: '0.5.0'
helm_tab_3_tab_text: '0.4.0'
# set attributes defining path components which will be assembled in the document
secrets: 'deployment/container/orchestration/orchestration.adoc#define-secrets'
ocis-charts-raw-url: 'https://raw.githubusercontent.com/owncloud/ocis-charts/'
values-versions-url: '/charts/ocis/docs/values.adoc.yaml'
values-desc-versions-url: '/charts/ocis/docs/values-desc-table.adoc'
compose_url: 'https://github.com/owncloud/ocis/tree/'
compose_raw_url: 'https://raw.githubusercontent.com/owncloud/ocis/'
compose_final_path: '/deployments/examples'
# production and rolling have separate paths when it comes to download from docker
docker_ocis_prod_url: https://hub.docker.com/r/owncloud/ocis
docker_ocis_rolling_url: https://hub.docker.com/r/owncloud/ocis-rolling
# only used in deployment/services via partials/env-and-yaml.adoc
# static path components, used to assemble the final path dependent on service_url_component to include services
ocis_services_raw_url: 'https://raw.githubusercontent.com/owncloud/ocis/'
ocis_services_final_path: '/services/_includes/'
# used in deployment orchestration and depl-examples
wopi_subdir: /ocis_wopi
download-gh-directory-url: https://download-directory.github.io