Skip to content

Commit aedb958

Browse files
committed
update repo info in README
1 parent cae334e commit aedb958

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

README.adoc

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ ifdef::env-github[]
1717
:badges:
1818
endif::[]
1919
// Project URIs:
20-
:project-repo-name: couchbase/docs-ui
20+
:project-repo-name: couchbase/docs-ui-sandbox
2121
:url-project: https://github.com/{project-repo-name}
2222
:url-site: https://docs.couchbase.com
2323
:url-repo: [email protected]:{project-repo-name}.git
@@ -198,7 +198,7 @@ If you need to package the UI so you can use it to generate the documentation si
198198
If any errors are reported by lint, you'll need to fix them.
199199

200200
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`).
202202

203203
== Control the Visual Appearance of Pages
204204

@@ -382,12 +382,12 @@ Releasing the UI bundle consists of the following tasks:
382382
Fortunately, you don't have to do any of these steps yourself.
383383
These steps are fully automated by the `gulp release` task.
384384
In fact, you don't even have to run the `gulp release` task manually.
385-
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.
385+
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.
386386

387387
IMPORTANT: A release will only be made if the project validates.
388388
To validate the project, run `gulp pack` before pushing your changes to GitHub.
389389

390-
The release-docs-ui-bundle CI job is already configured, so there's nothing you need to do to make automated release work.
390+
The docs-ui-sandbox CI job is already configured, so there's nothing you need to do to make automated release work.
391391
All you have to do is commit your changes and push those commits to the master branch of the git repository.
392392
A few seconds later, a new bundle will be available for use with Antora.
393393
Run `git pull` to retrieve the updated README that includes the new URL.
@@ -420,7 +420,7 @@ In the CI job configuration, covered in the next section, you'll learn how this
420420
=== CI Job Configuration
421421

422422
Jenkins is used to execute the CI job that publishes the UI bundle.
423-
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.
423+
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.
424424
This section describes in detail how that job has been configured in case it must be recreated.
425425

426426
The release is performed by the cb-docs-robot GitHub account, which interacts with GitHub entirely using the GitHub API.
@@ -429,10 +429,10 @@ The release script authenticates with the GitHub API as the cb-docs-robot user u
429429
Create a new CI job from the Pipeline project template.
430430
On the configuration screen, select or populate the following settings:
431431

432-
.Configuration details for the Antora/release-docs-ui-bundle CI job
432+
.Configuration details for the Antora/docs-ui-sandbox CI job
433433
====
434434
General::
435-
* _Project name:_ `release-docs-ui-bundle`
435+
* _Project name:_ `docs-ui-sandbox`
436436
* _Description:_ Packs, tags, and releases the UI bundle whenever a non-ignored commit is pushed to the master branch of this repository.
437437
* [x] GitHub project
438438
** _Project url:_ `pass:a[{url-project}]`

0 commit comments

Comments
 (0)