Address more PR feedback

Shopify · Nov 12, 2019 · 29fa030 · 29fa030
1 parent 0ef97a1
commit 29fa030
Showing 1 changed file with 5 additions and 3 deletions.
diff --git a/1.0-Upgrade.md b/1.0-Upgrade.md
@@ -2,11 +2,11 @@
 
 **THIS MIGRATION GUIDE IS A WORK IN PROGRESS. THINGS CAN STILL CHANGE BEFORE 1.0**
 
-The `kubernetes-deploy` became `krane` in its 1.0 version, and besides the name change we also introduced new features and [breaking changes](CHANGELOG.md). This guide will help you transition to version 1.0 as smoothly as possible.
+`kubernetes-deploy` was renamed `krane` when version 1.0.0 was released. Version 1.0.0 introduced new features and [breaking changes](CHANGELOG.md). This guide will help you transition to version 1.0 as smoothly as possible.
 
 **TL;DR**:
 * The command-line interface was redesigned; besides the name change, there are breaking changes in several flags.
-* The only breaking change in the public API is the renaming of the `KubernetesDeploy` namespace to `Krane`.
+* There are breaking changes in the public API (such as the renaming of the `KubernetesDeploy` namespace to `Krane`, and the change in default values for different arguments of the public interface).
 * StatsD metrics will now be generated with the `krane` prefix.
 * `kubernetes-deploy` (now `krane deploy`) / `DeployTask` can no longer deploy global (non-namespaced) resources. A new command called `krane global-deploy` and a related class called `GlobalDeployTask` were added to replace that feature.
 * If you attempt to install two gems that have conflicting executables, `gem install` will warn you but the most recently installed one will win. This means that you can run both `kubernetes-deploy` 0.30.0 and `krane` 1.0.0 side by side by doing:
@@ -35,6 +35,8 @@ Old command | New command
 
 The following tables provide a mapping of the flags previously supported in `kubernetes-deploy` and their new version in `krane` (if applicable).
 
+Important: you can't repeat flags. If you need to provide multiple arguments for a flag, use a space-separated list (e.g. `-f file1.txt file2.txt`) unless specified otherwise.
+
 #### krane deploy
 
 Old flag | New flag | Comments
@@ -86,7 +88,7 @@ If you attempt to install two gems that have conflicting executables (as is the
 
 ```bash
 gem install kubernetes-deploy -v 0.30.0
-gem install krane -v 1.0.0
+gem install -f krane -v 1.0.0
 ```
 
 This can help you incrementally port scripts that use the old CLI to the new one.