Skip to content
This repository has been archived by the owner on May 6, 2022. It is now read-only.

Clean docs 2 #2620

Merged
merged 2 commits into from
May 13, 2019
Merged

Clean docs 2 #2620

merged 2 commits into from
May 13, 2019

Conversation

jberkhahn
Copy link
Contributor

Some more docs stuff.

@k8s-ci-robot k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels May 8, 2019
@jberkhahn
Copy link
Contributor Author

Note that some of this stuff is based on #2589 which hasn't been merged yet

jboyd01
jboyd01 reviewed May 9, 2019
View reviewed changes
Copy link
Contributor

@jboyd01 jboyd01 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/approve
overall looks good, I do think the text around "Abandoning a binding" could be reworked for a specific binding or indicate its all of an instance's bindings. Also, I doubt "stuck" is the best description for those not living service catalog day to day. For us "stuck" or "wedged" certainly means a resource that is in the state of being deleted but can't be due to an error encountered when requesting the resource be deleted at the broker. Perhaps an elaboration on what "stuck" means on the first occurance.

docs/tasks/stuck_instance.md

## Abandon a binding
```console
$ svcat unbind foobar-mysql --abandon
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: this is actually abandoning all bindings for the specified instance (title says "Abandon a binding"). Maybe change the title or add additional example that shows $ svcat unbind --name foobar-binding --abandon

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

good catch

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: jboyd01

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label May 9, 2019
@jberkhahn
Copy link
Contributor Author

@jboyd01 made changes per your suggestions

@jboyd01
Copy link
Contributor

jboyd01 commented May 9, 2019

Thanks @jberkhahn
/lgtm as well

@jboyd01
Copy link
Contributor

jboyd01 commented May 13, 2019

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm Indicates that a PR is ready to be merged. label May 13, 2019
@k8s-ci-robot k8s-ci-robot merged commit 01a439e into kubernetes-retired:master May 13, 2019
viviyww pushed a commit to viviyww/service-catalog that referenced this pull request Jun 20, 2019
@jberkhahn
Clean docs 2 (kubernetes-retired#2620)
222369a 
* remove unneeded section from docs

* Add task section about removing stuck instances
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@jboyd01 jboyd01 jboyd01 left review comments

@MHBauer MHBauer Awaiting requested review from MHBauer

Assignees
No one assigned
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. lgtm Indicates that a PR is ready to be merged. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@jberkhahn @k8s-ci-robot @jboyd01