You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.adoc
+6-6Lines changed: 6 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -198,7 +198,7 @@ If you need to package the UI so you can use it to generate the documentation si
198
198
If any errors are reported by lint, you'll need to fix them.
199
199
200
200
When the command completes successfully, the UI bundle will be available at [.path]_build/ui-bundle.zip_.
201
-
You can point Antora at this bundle using the `--ui-bundle-url` command-line option (e.g., `--ui-bundle-url=../docs-ui/build/ui-bundle.zip`).
201
+
You can point Antora at this bundle using the `--ui-bundle-url` command-line option (e.g., `--ui-bundle-url=../docs-ui-sandbox/build/ui-bundle.zip`).
202
202
203
203
== Control the Visual Appearance of Pages
204
204
@@ -437,12 +437,12 @@ Releasing the UI bundle consists of the following tasks:
437
437
Fortunately, you don't have to do any of these steps yourself.
438
438
These steps are fully automated by the `gulp release` task.
439
439
In fact, you don't even have to run the `gulp release` task manually.
440
-
When a commit is pushed to the master branch of the repository, it triggers the CI job named *release-docs-ui-bundle*, which executes the `gulp release` task using pre-configured credentials.
440
+
When a commit is pushed to the master branch of the repository, it triggers the CI job named *docs-ui-sandbox*, which executes the `gulp release` task using pre-configured credentials.
441
441
442
442
IMPORTANT: A release will only be made if the project validates.
443
443
To validate the project, run `gulp pack` before pushing your changes to GitHub.
444
444
445
-
The release-docs-ui-bundle CI job is already configured, so there's nothing you need to do to make automated release work.
445
+
The docs-ui-sandbox CI job is already configured, so there's nothing you need to do to make automated release work.
446
446
All you have to do is commit your changes and push those commits to the master branch of the git repository.
447
447
A few seconds later, a new bundle will be available for use with Antora.
448
448
Run `git pull` to retrieve the updated README that includes the new URL.
@@ -475,7 +475,7 @@ In the CI job configuration, covered in the next section, you'll learn how this
475
475
=== CI Job Configuration
476
476
477
477
Jenkins is used to execute the CI job that publishes the UI bundle.
478
-
The job is named *release-docs-ui-bundle* and can be found under the *Antora* folder in the Jenkins server managed by the Couchbase docs team.
478
+
The job is named *docs-ui-sandbox* and can be found under the *Antora* folder in the Jenkins server managed by the Couchbase docs team.
479
479
This section describes in detail how that job has been configured in case it must be recreated.
480
480
481
481
The release is performed by the cb-docs-robot GitHub account, which interacts with GitHub entirely using the GitHub API.
@@ -484,10 +484,10 @@ The release script authenticates with the GitHub API as the cb-docs-robot user u
484
484
Create a new CI job from the Pipeline project template.
485
485
On the configuration screen, select or populate the following settings:
486
486
487
-
.Configuration details for the Antora/release-docs-ui-bundle CI job
487
+
.Configuration details for the Antora/docs-ui-sandbox CI job
488
488
====
489
489
General::
490
-
* _Project name:_ `release-docs-ui-bundle`
490
+
* _Project name:_ `docs-ui-sandbox`
491
491
* _Description:_ Packs, tags, and releases the UI bundle whenever a non-ignored commit is pushed to the master branch of this repository.
0 commit comments