astra-streaming-docs/antora.yml at main · datastax/astra-streaming-docs · GitHub

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
name: 'astra-streaming'
title: 'Astra Streaming'
version: ~
start_page: 'index.adoc'

nav:
- modules/ROOT/nav.adoc

asciidoc:
  attributes:
    company: 'DataStax'
    support-url: 'https://www.ibm.com/mysupport/s/'
    astra-db: 'Astra DB'
    product: 'Astra Streaming'
    astra: 'Astra' # This attribute is also used in include::common partials.
    astra-cli: 'Astra CLI'
    astra-ui: 'Astra Portal'
    astra-url: 'https://astra.datastax.com'
    astra-ui-link: '{astra-url}[{astra-ui}^]'
    db-serverless: 'Serverless (non-vector)'
    db-serverless-vector: 'Serverless (vector)'
    devops-api: 'DevOps API'
    devops-api-ref-url: 'xref:astra-api-docs:ROOT:attachment$devops-api/index.html'
    cass: 'Apache Cassandra'
    cass-reg: 'Apache Cassandra(R)'
    cass-short: 'Cassandra'
    cql: 'Cassandra Query Language (CQL)'
    cql-shell: 'CQL shell'
    cql-console: 'CQL console'
    pulsar: 'Apache Pulsar'
    pulsar-short: 'Pulsar'
    pulsar-reg: 'Apache Pulsar(TM)'
    pulsar-version: '3.1' #Don't include patch version (major.minor.patch)
    pulsar-version-patch: '3.1.0'
    kafka-reg: 'Apache Kafka(R)'
    kafka: 'Apache Kafka'
    kafka-short: 'Kafka'
    kafka-connect: 'Kafka Connect'
    maven-reg: 'Apache Maven(TM)'
    maven-short: 'Maven'
    flink-reg: 'Apache Flink(R)'
    geode-reg: 'Apache Geode(TM)'
    hbase-reg: 'Apache HBase(R)'
    kudu-reg: 'Apache Kudu(TM)'
    phoenix-reg: 'Apache Phoenix(TM)'
    solr-reg: 'Apache Solr(TM)'
    starlight-kafka: 'Starlight for Kafka'
    starlight-rabbitmq: 'Starlight for RabbitMQ'
    gpt-schema-translator: 'GPT schema translator'

    # Required for include::common partials; some shared with Luna Streaming
    web-ui: '{astra-ui}'
    debezium-version: '1.7'
    scb: 'Secure Connect Bundle (SCB)'
    scb-short: 'SCB'
    scb-brief: 'Secure Connect Bundle'
    pulsar-admin-functions-cli-ref-url: 'https://pulsar.apache.org/docs/{pulsar-version}.x/functions-cli'
    pulsar-admin-sinks-ref-url: 'https://pulsar.apache.org/reference/#/{pulsar-version}.x/pulsar-admin/sinks'
    pulsar-admin-sources-ref-url: 'https://pulsar.apache.org/reference/#/{pulsar-version}.x/pulsar-admin/sources'
    pulsar-person-class-spec-url: 'https://github.com/apache/pulsar/blob/branch-{pulsar-version}/pulsar-io/data-generator/src/main/java/org/apache/pulsar/io/datagenerator/Person.java'
    debezium-release-url: 'https://debezium.io/releases/{debezium-version}'

    # Astra role attributes (compare with astra-vector-docs antora.yml)
    organization-administrator-role: 'xref:astra-db-serverless:administration:rbac.adoc#organization-administrator-role[Organization Administrator]'
    administrator-service-account-role: 'xref:astra-db-serverless:administration:rbac.adoc#administrator-service-account-role[Administrator Service Account]'
    api-administrator-service-account-role: 'xref:astra-db-serverless:administration:rbac.adoc#api-administrator-service-account-role[API Administrator Service Account]'
    api-administrator-user-role: 'xref:astra-db-serverless:administration:rbac.adoc#api-administrator-user-role[API Administrator User]'

    # Astra permission attributes (compare with astra-vector-docs antora.yml)
    manage-streaming-permission: 'xref:astra-db-serverless:administration:rbac.adoc#manage-streaming-permission[Manage Streaming]'
    view-db-permission: 'xref:astra-db-serverless:administration:rbac.adoc#view-db-permission[View DB]'

    # For more attributes, see release.yml in the datastax-docs-site repo