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
@@ -215,7 +215,7 @@ If you need to package the UI so you can use it to generate the documentation si
215
215
If any errors are reported by lint, you'll need to fix them.
216
216
217
217
When the command completes successfully, the UI bundle will be available at [.path]_build/ui-bundle.zip_.
218
-
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`).
218
+
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`).
219
219
220
220
== Control the Visual Appearance of Pages
221
221
@@ -454,12 +454,12 @@ Releasing the UI bundle consists of the following tasks:
454
454
Fortunately, you don't have to do any of these steps yourself.
455
455
These steps are fully automated by the `gulp release` task.
456
456
In fact, you don't even have to run the `gulp release` task manually.
457
-
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.
457
+
When a commit is pushed to the master branch of the repository, it triggers the CI job named *docs-ui*, which executes the `gulp release` task using pre-configured credentials.
458
458
459
459
IMPORTANT: A release will only be made if the project validates.
460
460
To validate the project, run `gulp pack` before pushing your changes to GitHub.
461
461
462
-
The docs-ui-sandbox CI job is already configured, so there's nothing you need to do to make automated release work.
462
+
The docs-ui CI job is already configured, so there's nothing you need to do to make automated release work.
463
463
All you have to do is commit your changes and push those commits to the master branch of the git repository.
464
464
A few seconds later, a new bundle will be available for use with Antora.
465
465
Run `git pull` to retrieve the updated README that includes the new URL.
@@ -492,7 +492,7 @@ In the CI job configuration, covered in the next section, you'll learn how this
492
492
=== CI Job Configuration
493
493
494
494
Jenkins is used to execute the CI job that publishes the UI bundle.
495
-
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.
495
+
The job is named *docs-ui* and can be found under the *Antora* folder in the Jenkins server managed by the Couchbase docs team.
496
496
This section describes in detail how that job has been configured in case it must be recreated.
497
497
498
498
The release is performed by the cb-docs-robot GitHub account, which interacts with GitHub entirely using the GitHub API.
@@ -501,10 +501,10 @@ The release script authenticates with the GitHub API as the cb-docs-robot user u
501
501
Create a new CI job from the Pipeline project template.
502
502
On the configuration screen, select or populate the following settings:
503
503
504
-
.Configuration details for the Antora/docs-ui-sandbox CI job
504
+
.Configuration details for the Antora/docs-ui CI job
505
505
====
506
506
General::
507
-
* _Project name:_ `docs-ui-sandbox`
507
+
* _Project name:_ `docs-ui`
508
508
* _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