Skip to content

Commit 340065f

Browse files
DOC-3701: Migrate to official @asciidoctor/tabs extension (#146)
* Migrate to official @asciidoctor/tabs extension * Fix attributes in README * Remove CODEOWNERS file * Align local/publish Antora build commands * Update GTM and Segment site keys
1 parent dd1a276 commit 340065f

File tree

6 files changed

+23
-100
lines changed

6 files changed

+23
-100
lines changed

README.adoc

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
1-
= {company} Zero Downtime Migration (ZDM) Documentation
1+
= {company} {product} Documentation
22
:toc: macro
3-
:product: Zero Downtime Migration
3+
:company: DataStax
4+
:product: Zero Downtime Migration (ZDM)
45
:product-repo-name: migration-docs
56
:product-repo-name-long: datastax/migration-docs
67
:product-repo-link: https://github.com/datastax/migration-docs.git
@@ -16,7 +17,7 @@
1617
:contributor-docs-link: https://docs.google.com/presentation/d/10RjxURHpJ8gwac0dCZ02pKo31nGhem29Z8-xERApyWU/edit?usp=sharing
1718
:web-server-link: https://www.npmjs.com/package/serve
1819

19-
This repo contains the documentation source files for the {company} {zdm-product} documentation.
20+
This repo contains the documentation source files for the {company} {product} documentation.
2021

2122
The docs are written in {asciidoctor-link}[AsciiDoc] and use {antora-link}[Antora] to generate the HTML output.
2223

@@ -26,7 +27,7 @@ toc::[]
2627

2728
Although this repo is maintained by the {company} Docs team, contributions from the community are gratefully accepted, and encouraged.
2829

29-
_Why should you contribute to the {zdm-product} docs?_::
30+
_Why should you contribute to the {product} docs?_::
3031
* It makes the Docs team's job easier.
3132
* It makes your job easier.
3233
* It helps {company} and Cassandra users more quickly.
@@ -38,7 +39,7 @@ You can contribute to the documentation by adding content to, or editing, the As
3839
For instructions, see <<writing-asciidoc>> below.
3940

4041
[[writing-asciidoc]]
41-
== Working with {zdm-product} docs
42+
== Working with {product} docs
4243

4344
Before following the steps below, first make sure that you have {install-git-link}[git] installed on your computer.
4445

docs-src/.DS_Store

-8 KB
Binary file not shown.

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:zdm": "npm run build:publish:zdm",
55
"build:dev:zdm": "npm run build:local:zdm",
6-
"build:publish:zdm": "antora --log-level error --fetch --clean playbooks/site-publish-zdm.yaml",
6+
"build:publish:zdm": "antora --stacktrace --fetch --clean playbooks/site-publish-zdm.yaml",
77
"build:local:zdm": "antora --stacktrace --fetch --clean playbooks/site-local-zdm.yaml",
88
"build:linkinator:zdm": "npx linkinator https://docs.datastax.com/en/zdm/docs/ --recurse --skip ' https://localhost?'"
99
},
@@ -12,10 +12,11 @@
1212
"url": "git+https://github.com/datastax/migration-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-zdm.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
zdm-product: 'Zero Downtime Migration'
@@ -126,4 +126,4 @@ asciidoc:
126126
glossary-url: 'https://docs.datastax.com/en/glossary/docs/index.html#'
127127

128128
extensions:
129-
- ./lib/tabs-block.js
129+
- '@asciidoctor/tabs'

playbooks/site-publish-zdm.yaml

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,12 @@
11
site:
22
title: DataStax Zero Downtime Migration
33
url: https://docs.datastax.com/en/zdm/docs
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
zdm-product: 'Zero Downtime Migration'
@@ -136,5 +137,5 @@ asciidoc:
136137
# "<repo-name>: 'ssh://github.com/<org-name>/<repo-name>.git'".
137138
migration-docs: 'ssh://github.com/datastax/migration-docs.git'
138139

139-
extensions:
140-
- '~/work/migration-docs/playbooks/lib/tabs-block.js'
140+
extensions:
141+
- '@asciidoctor/tabs'

0 commit comments

Comments
 (0)