Adding more small fixes to the walkthrough & install docs #1169
Conversation
And declaring the abbreviation for “Certificate Authority”
k8s-ci-robot
added
cncf-cla: yes
docs/walkthrough-1.6.md
Outdated
| @@ -277,9 +277,9 @@ ups-instance-credential Opaque 2 | |||
|
|
|||
| Notice that a new `Secret` named `ups-instance-credential` has been created. | |||
|
|
|||
| # Step 6 - Unbinding from the ServiceInstance | |||
| # Step 6 - Deleting the `ServiceInstanceCredentials` | |||
There was a problem hiding this comment.
nit, this is singular instead of plural
There was a problem hiding this comment.
good catch, thanks
|
One nit and LGTM |
|
Thanks for the review @pmorie |
docs/walkthrough-1.6.md
Outdated
|
|
||
| # Step 1 - Installing the UPS ServiceBroker | ||
| # Step 1 - Installing the UPS Broker Server |
There was a problem hiding this comment.
Hmmm, isn't "Service Broker" more appropriate?
There was a problem hiding this comment.
or even "Service Broker Server" if you're trying to be less OSB-API-y
There was a problem hiding this comment.
I can do "Service Broker Server". I need to clearly differentiate it from the ServiceBroker resource.
|
|
||
| Now, let's unbind from the instance. To do this, we simply *delete* the | ||
| Now, let's unbind from the provisioned instance. To do this, we simply *delete* the |
There was a problem hiding this comment.
seems inconsistent to use 'delete' in the title but 'unbind' in the text. I'm ok with either one, but we should be consistent
There was a problem hiding this comment.
@duglin this document tries to equate Kubernetes actions (delete in this case) with the equivalent OSB concept (unbind in this case), so I kept with that trend.
There was a problem hiding this comment.
as a newbie I would be confused by the switch in verbs, perhaps do something like:
Now, let's unbind from (delete) the provisioned instance
There was a problem hiding this comment.
no that's not right either....
There was a problem hiding this comment.
skip my comment - we can tweak it in a follow-on PR
There was a problem hiding this comment.
@duglin if you'd like to switch the verbs around, I'm happy to do that. It'll require a change in the rest of the doc too, so how about we do that in a follow-up?
|
LGTM |
|
waiting on CI.... |
|
thanks @duglin |
This is a follow-up to #1163.