Skip to content

Commit fac08b9

Browse files
DOC-3701: Migrate to official @asciidoctor/tabs extension (#5)
* Migrate to official @asciidoctor/tabs extension * Align local/publish Antora build commands * Update GTM and Segment site keys
1 parent 33c8f53 commit fac08b9

File tree

5 files changed

+17
-95
lines changed

5 files changed

+17
-95
lines changed

README.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
= DataStax {product} Documentation
22
:toc: macro
3-
:product: astra-cli-docs
3+
:product: Astra CLI
44
:product-repo-name: astra-cli-docs
55
:product-repo-name-long: datastax/astra-cli-docs
66
:product-repo-link: https://github.com/datastax/astra-cli-docs.git

package.json

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
"scripts": {
44
"build:prod:astra-cli": "npm run build:publish:astra-cli",
55
"build:dev:astra-cli": "npm run build:local:astra-cli",
6-
"build:publish:astra-cli": "antora --log-level error --fetch --clean playbooks/site-publish-astra-cli.yaml",
6+
"build:publish:astra-cli": "antora --stacktrace --fetch --clean playbooks/site-publish-astra-cli.yaml",
77
"build:local:astra-cli": "antora --stacktrace --fetch --clean playbooks/site-local-astra-cli.yaml",
88
"build:linkinator:astra-cli": "npx linkinator https://docs.datastax.com/en/astra-cli/docs/ --recurse --skip ' https://localhost?'"
99
},
@@ -12,10 +12,11 @@
1212
"url": "git+https://github.com/datastax/astra-cli-docs.git"
1313
},
1414
"dependencies": {
15-
"@antora/cli": "~3.0.1",
16-
"@antora/site-generator-default": "~3.0.1",
17-
"linkinator": "~3.0.3",
15+
"@antora/cli": "~3.1",
16+
"@antora/site-generator": "~3.1",
17+
"@asciidoctor/tabs": "^1.0.0-beta.5",
1818
"async": "~3.2.4",
19+
"linkinator": "~3.0.3",
1920
"mobx": "~6.0.4",
2021
"react": "~16.8.4",
2122
"react-dom": "~16.8.4",

playbooks/lib/tabs-block.js

Lines changed: 0 additions & 80 deletions
This file was deleted.

playbooks/site-local-astra-cli.yaml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -34,8 +34,8 @@ asciidoc:
3434
page-pagination: ''
3535
sectanchors: ''
3636
sectlinks: ''
37-
id-prefix: ''
38-
id-separator: '-'
37+
idprefix: ''
38+
idseparator: '-'
3939

4040
company: 'DataStax'
4141
product: 'Product'
@@ -123,4 +123,4 @@ asciidoc:
123123
glossary-url: 'https://docs.datastax.com/en/glossary/docs/index.html#'
124124

125125
extensions:
126-
- ./lib/tabs-block.js
126+
- '@asciidoctor/tabs'

playbooks/site-publish-astra-cli.yaml

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,12 @@
11
site:
22
title: DataStax Astra CLI
33
url: https://docs.datastax.com/en/astra-cli
4-
# The keys.segmentIo site key must be in the site-publish playbook of each
5-
# docset. This loads Segment into the docset build, and is a requirement for
6-
# collecting site analytics.
4+
# The google_analytics and segment_io site keys must be in the release playbook
5+
# of each docset. This ensures that the Google Tag Manager (GTM) and Segment
6+
# scripts get loaded into the docsets that get published to docs.datastax.com.
77
keys:
8-
segmentIo: d24gQtyKIUu5mLdkp11xjfiXLhRqx0HH
8+
google_analytics: 'GTM-5FSG7Q'
9+
segment_io: 'd24gQtyKIUu5mLdkp11xjfiXLhRqx0HH'
910

1011
output:
1112
# Bsys requires the output.dir in the site-publish playbook to be specifically
@@ -38,8 +39,8 @@ asciidoc:
3839
page-pagination: ''
3940
sectanchors: ''
4041
sectlinks: ''
41-
id-prefix: ''
42-
id-separator: '-'
42+
idprefix: ''
43+
idseparator: '-'
4344

4445
company: 'DataStax'
4546
product: 'Product'
@@ -131,4 +132,4 @@ asciidoc:
131132
astra-cli-docs: 'ssh://github.com/datastax/astra-cli-docs.git'
132133

133134
extensions:
134-
- ~/work/astra-cli-docs/playbooks/lib/tabs-block.js
135+
- '@asciidoctor/tabs'

0 commit comments

Comments
 (0)