Skip to content

Commit 909ec54

Browse files
Centralize local builds
1 parent f9ad28d commit 909ec54

File tree

8 files changed

+11
-656
lines changed

8 files changed

+11
-656
lines changed

docs/README.adoc

Lines changed: 10 additions & 144 deletions
Original file line numberDiff line numberDiff line change
@@ -1,159 +1,25 @@
1-
= {company} {product} Docs
1+
= {company} {product} docs
22
// Variables:
33
:company: DataStax
44
:product: CDC for Apache Cassandra
5-
:repo-name: cdc-apache-cassandra
6-
:github-org: datastax
7-
// Settings:
5+
// Document settings:
86
:toc: macro
7+
:toclevels: 2
8+
:idprefix:
9+
:idseparator: -
910
:!example-caption:
11+
:!figure-caption:
12+
:!table-caption:
1013
:experimental:
1114
:hide-uri-scheme:
1215
ifdef::env-github[]
13-
:icons: font
14-
:toclevels: 1
15-
:toc-title: Contents
1616
:tip-caption: :bulb:
17-
:note-caption: :information_source:
17+
:note-caption: :paperclip:
1818
:important-caption: :heavy_exclamation_mark:
1919
:caution-caption: :fire:
2020
:warning-caption: :warning:
21-
:badges:
2221
endif::[]
23-
// Project URLs:
24-
:url-github-org: https://github.com/{github-org}
25-
:url-project-repo: {url-github-org}/{repo-name}
26-
:url-ui-repo: https://github.com/riptano/docs-ui
27-
:url-playbook-repo: https://github.com/riptano/datastax-docs-site
28-
:url-contribute:
29-
:url-datastax: https://datastax.com
30-
:url-datastax-docs: https://docs.datastax.com
31-
:url-docs-preview: http://docs-preview.datastax.com
32-
// External URLs:
33-
:asciidoc-language: https://docs.asciidoctor.org/asciidoc/latest/
3422

35-
This repository contains the source files for the {company} {product} documentation.
23+
This repository contains the https://docs.asciidoctor.org/asciidoc/latest/[AsciiDoc] source files for the {company} {product} documentation.
3624

37-
toc::[]
38-
39-
== Get started
40-
41-
The documentation is written in {asciidoc-language}[AsciiDoc]-formatted source files located in the `modules` directory.
42-
43-
=== Make a simple update
44-
45-
For simple updates like fixing typos or modifying existing prose, it's easiest to edit the source files directly on GitHub.
46-
47-
NOTE: You'll need Write privileges on the repository to edit files directly on GitHub.
48-
49-
. Find the file you want to edit in the `modules` directory.
50-
51-
. Click the *Edit* icon in the upper-right corner of the file view.
52-
53-
. Make your changes in the editor.
54-
55-
. Click *Commit changes...*
56-
57-
. Enter a description for your commit and click *Propose changes*.
58-
59-
. On the *Open a pull request* screen, enter a title and description for your change, assign reviewers, then click *Create pull request*.
60-
61-
. Once the pull request is open, an automatic draft preview build is triggered.
62-
Once complete, the build system posts a comment on the pull request with a link to the draft site for you to preview your changes.
63-
64-
=== Edit docs locally
65-
66-
If you need to make substantial updates to the documentation, you'll want to clone the repository so you can work with the source files locally.
67-
68-
. Clone this repository
69-
+
70-
[source,bash,subs="attributes"]
71-
----
72-
git clone {url-project-repo}.git
73-
----
74-
75-
. https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-personal-access-token-classic[Create a _classic_ personal access token] for your GitHub account.
76-
When configuring the token, set the *Expiration* to at least 90 days and select everything under the *Repo* https://docs.github.com/en/apps/oauth-apps/building-oauth-apps/scopes-for-oauth-apps#available-scopes[scope].
77-
+
78-
[IMPORTANT]
79-
====
80-
Copy your personal access token to a temporary location -- you'll need it later.
81-
====
82-
83-
. https://docs.github.com/en/enterprise-cloud@latest/authentication/authenticating-with-saml-single-sign-on/authorizing-a-personal-access-token-for-use-with-saml-single-sign-on[Authorize your personal access token] so that it can access repositories in the Riptano and DataStax organizations in GitHub.
84-
85-
. https://docs.antora.org/antora/latest/playbook/private-repository-auth/#populate-credentials-directly[Populate the credential store] with your personal access token.
86-
For most people this means doing the following:
87-
+
88-
.. Create the file `$HOME/.git-credentials` and open it in your editor.
89-
.. Add the following line:
90-
+
91-
[source,subs="verbatim,quotes"]
92-
----
93-
https://**TOKEN**:@github.com
94-
----
95-
+
96-
Replace *`TOKEN`* with the personal access token you copied from GitHub.
97-
.. Save and close the file.
98-
99-
. If you don't already have Node.js installed, do the following:
100-
101-
.. Install https://github.com/nvm-sh/nvm[nvm].
102-
+
103-
If you're on macOS, you can install nvm using https://brew.sh/[Homebrew]:
104-
+
105-
[source,bash]
106-
----
107-
brew install nvm
108-
----
109-
110-
.. Use nvm to install Node.js.
111-
+
112-
[source,bash]
113-
----
114-
nvm install --lts
115-
----
116-
+
117-
[source,bash]
118-
----
119-
nvm use --lts
120-
----
121-
+
122-
[source,bash]
123-
----
124-
nvm alias default node
125-
----
126-
127-
. Install the project dependencies.
128-
+
129-
[source,bash,subs="attributes"]
130-
----
131-
cd {repo-name}/docs
132-
----
133-
+
134-
[source,bash]
135-
----
136-
npm install
137-
----
138-
139-
. Build the site.
140-
+
141-
[source,bash]
142-
----
143-
npm run build:local
144-
----
145-
+
146-
If the build was successful, you'll see the following output in your terminal:
147-
+
148-
[source,console,subs="attributes"]
149-
----
150-
Site generation complete!
151-
Open file:///Users/USERNAME/repos/{repo-name}/build/site/index.html in a browser to view your site.
152-
----
153-
+
154-
To view the site, paste the entire `\file:///` path into your browser's address bar and press kbd:[Return].
155-
156-
[#publish-docs]
157-
== Publish docs
158-
159-
To learn how to publish documentation to {url-datastax-docs}, see the {url-playbook-repo}#deploy-production[datastax-docs-site README].
25+
To learn how to update the documentation, see the https://datastax.jira.com/wiki/spaces/DOCS/overview[Docs team Confluence site].

docs/extensions/assets-processor.js

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

docs/extensions/remote-include-processor.js

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

0 commit comments

Comments
 (0)