Skip to content

Commit 36274a0

Browse files
porridgekensipe
authored andcommitted
Some doc and comment corrections. (#181)
1 parent 0073ce6 commit 36274a0

File tree

2 files changed

+8
-8
lines changed

2 files changed

+8
-8
lines changed

Build.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@ The repository build process is a 2 step process. First build the set of operato
44

55
The "community" repository is the repository for all operators in the community and is a default location for all operator builds. The build process expects the following prerequisites:
66

7-
1. `kubectl-kudo` is in the path
8-
2. `bash` is the shell
9-
3. you have online web access to the "community" repository during the build process.
7+
1. `kubectl-kudo` and `bash` are in the path
8+
1. your working directory is the root of the checked out `operators` Git repository
9+
1. you have online web access to the "community" repository during the build process.
1010

1111
## Step 1: Build Operators
1212

@@ -23,15 +23,15 @@ Another convention is to have a version number associated with the build using t
2323
`./build-operator.sh cassandra 3.11`
2424

2525
**NOTES:**
26-
1. All builds will be under `build/repo` under the project
27-
1. All operator packages built will be under `build/repo`. If you want to add more than 1 operator, build multiple operator packages before building the repository index.
26+
1. Built artifacts will be put under `build/repo` in the current directory.
27+
1. If you want to add more than 1 operator, build multiple operator packages before building the repository index.
2828
3. There is no rebuild and if the operator already exists the build will fail.
2929

3030
## Step 2: Build Repository Index
3131

3232
To build the repository index simple run `./build-community-repo.sh` or `make index`.
3333

34-
This will build a `index.yaml` file under `build/repo`
34+
This will build an `index.yaml` file under `build/repo`.
3535

3636
## Clean the build
3737

build-community-repo.sh

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,8 +30,8 @@ if [[ ! -d "${REPO_DIR}" ]]; then
3030
fi
3131

3232

33-
# test to confirm community repo is configured
34-
# this command will fail if it exists non-zero
33+
# test to confirm community repo is configured
34+
# this command will fail non-zero unless it exists
3535
$CMD repo context community
3636

3737
$CMD repo index $REPO_DIR --merge-repo community --url-repo community

0 commit comments

Comments
 (0)