Skip to content

Commit a9dc789

Browse files
committed
update files to reflect repository name change [skip ci]
1 parent 8748ef3 commit a9dc789

File tree

3 files changed

+11
-11
lines changed

3 files changed

+11
-11
lines changed

Jenkinsfile

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,11 @@ def githubApiTokenCredentials = string(credentialsId: githubApiTokenCredentialsI
66
// Jenkins job configuration
77
// -------------------------
88
// Category: Multibranch Pipeline
9-
// Pipeline name: docs-ui-sandbox
9+
// Pipeline name: docs-ui
1010
// Branch Sources: Single repository & branch
1111
// Name: master
1212
// Source Code Management: Git
13-
// Repository URL: https://github.com/couchbase/docs-ui-sandbox
13+
// Repository URL: https://github.com/couchbase/docs-ui
1414
// Credentials: - none -
1515
// Branch specifier: refs/heads/master
1616
// Advanced clone behaviors: [ ] Fetch tags, [x] Honor refspec on initial clone, [x] Shallow clone, Shallow clone depth: 5

README.adoc

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -17,12 +17,12 @@ ifdef::env-github[]
1717
:badges:
1818
endif::[]
1919
// Project URIs:
20-
:project-repo-name: couchbase/docs-ui-sandbox
20+
:project-repo-name: couchbase/docs-ui
2121
:url-project: https://github.com/{project-repo-name}
2222
:url-site: https://docs.couchbase.com
2323
:url-repo: git@github.com:{project-repo-name}.git
2424
//:url-preview: https://cb-docs-ui.netlify.com
25-
:url-preview: https://cb-docs-ui-sandbox.netlify.app
25+
:url-preview: https://cb-docs-ui.netlify.app
2626
// External URIs:
2727
:url-antora: https://antora.org
2828
:url-git: https://git-scm.com
@@ -215,7 +215,7 @@ If you need to package the UI so you can use it to generate the documentation si
215215
If any errors are reported by lint, you'll need to fix them.
216216

217217
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`).
219219

220220
== Control the Visual Appearance of Pages
221221

@@ -454,12 +454,12 @@ Releasing the UI bundle consists of the following tasks:
454454
Fortunately, you don't have to do any of these steps yourself.
455455
These steps are fully automated by the `gulp release` task.
456456
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.
458458

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

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.
463463
All you have to do is commit your changes and push those commits to the master branch of the git repository.
464464
A few seconds later, a new bundle will be available for use with Antora.
465465
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
492492
=== CI Job Configuration
493493

494494
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.
496496
This section describes in detail how that job has been configured in case it must be recreated.
497497

498498
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
501501
Create a new CI job from the Pipeline project template.
502502
On the configuration screen, select or populate the following settings:
503503

504-
.Configuration details for the Antora/docs-ui-sandbox CI job
504+
.Configuration details for the Antora/docs-ui CI job
505505
====
506506
General::
507-
* _Project name:_ `docs-ui-sandbox`
507+
* _Project name:_ `docs-ui`
508508
* _Description:_ Packs, tags, and releases the UI bundle whenever a non-ignored commit is pushed to the master branch of this repository.
509509
* [x] GitHub project
510510
** _Project url:_ `pass:a[{url-project}]`

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
"license": "MPL-2.0",
66
"repository": {
77
"type": "git",
8-
"url": "https://github.com/couchbase/docs-ui-sandbox"
8+
"url": "https://github.com/couchbase/docs-ui"
99
},
1010
"engines": {
1111
"node": ">= 10.0.0"

0 commit comments

Comments
 (0)