Skip to content

Commit 52d90ac

Browse files
authored
tweaks (#128)
Signed-off-by: Michael Kalantar <[email protected]>
1 parent 1b11fcb commit 52d90ac

File tree

4 files changed

+14
-18
lines changed

4 files changed

+14
-18
lines changed

CONTRIBUTING.md

Lines changed: 9 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ If anything doesn't make sense, or doesn't work when you run it, please open a b
1414

1515
We welcome many types of contributions including:
1616

17-
* [CLI and Iter8 performance test charts](#iter8-toolsiter8)
17+
* [Iter8 controller and test charts](#iter8-toolsiter8)
1818
* [Docs](#iter8-toolsdocs)
1919
* CI, builds, and tests
2020
* Reviewing pull requests
@@ -26,7 +26,7 @@ The best ways to reach us with a question is to ask...
2626
* On the original GitHub issue
2727
* In the `#development` channel in the [Iter8 Slack workspace](https://join.slack.com/t/iter8-tools/shared_invite/zt-awl2se8i-L0pZCpuHntpPejxzLicbmw)
2828

29-
## Find an issue
29+
## Find or file an issue
3030

3131
Iter8 issues are tracked [here](https://github.com/iter8-tools/iter8/issues).
3232

@@ -84,17 +84,6 @@ This is the source repo for Iter8 CLI.
8484
git clone https://github.com/iter8-tools/iter8.git
8585
```
8686

87-
#### Build Iter8
88-
```shell
89-
make build
90-
```
91-
92-
#### Install Iter8 locally
93-
```shell
94-
make clean install
95-
iter8 version
96-
```
97-
9887
#### Run unit tests and see coverage information
9988
```shell
10089
make tests
@@ -122,6 +111,13 @@ docker build -f docker/Dockerfile -t $IMG .
122111
docker push $IMG
123112
```
124113

114+
#### Install controller
115+
116+
To install a development build of the controller, set the `image` property to the name of the Docker image $IMG:
117+
118+
```helm upgrade --install --repo https://iter8-tools.github.io/iter8 --version 0.18 contoller \
119+
--set image=$IMG```
120+
125121
### iter8-tools/docs
126122
127123
This is the source repo for Iter8 documentation.

docs/getting-started/first-release.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
template: main.html
33
---
44

5-
# Your first blue-green release
5+
# Your first progressive release
66

77
This tutorial shows how Iter8 can be used to release a basic Kubernetes application using a blue-green rollout strategy.
88
In a blue-green rollout, a percentage of requests are directed to a candidate version of the model.

mkdocs.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -114,14 +114,14 @@ markdown_extensions:
114114
nav:
115115
- Home: index.md
116116
- Getting Started:
117-
- Your first blue-green release: getting-started/first-release.md
117+
- Your first progressive release: getting-started/first-release.md
118118
- Your first A/B test: getting-started/first-abn.md
119119
- Your first performance test: getting-started/first-performance.md
120120
- Concepts: getting-started/concepts.md
121121
- Advantages: getting-started/advantages.md
122122
- Get help: getting-started/help.md
123123
- Tutorials:
124-
- Blue-green release: tutorials/blue-green.md
124+
- Progressive (blue-green) release: tutorials/blue-green.md
125125
- A/B testing with Iter8 SDK: tutorials/abn.md
126126
- Performance test HTTP: tutorials/load-test-http.md
127127
- Performance test multiple HTTP endpoints: tutorials/load-test-http-multiple.md

overrides/home.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -96,9 +96,9 @@ <h3>
9696
Progressive release with automated traffic management
9797
</li>
9898
<li>
99-
A/B/n testing wtih client SDK and business metrics
99+
A/B/n testing with client SDK and business metrics
100100
</li>
101-
<li class="roadmap">
101+
<li>
102102
Performance testing for HTTP and gRPC endpoints
103103
</li>
104104
</ul>

0 commit comments

Comments
 (0)