Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add documentation around removing a user from an organization or space #977

Merged
merged 5 commits into from
Jul 25, 2017

Conversation

rememberlenny
Copy link
Contributor

@rememberlenny rememberlenny commented Jul 21, 2017

Feel free to directly make changes to this pull request.

@rememberlenny
Copy link
Contributor Author

This PR adds documentation that is reference by cloud-gov/cg-dashboard#1163

@rememberlenny rememberlenny requested a review from suprenant July 21, 2017 16:46

{{% dashboard %}}

### Organization Users
Copy link
Contributor

Choose a reason for hiding this comment

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

@rememberlenny I'll push a commit that lowercases users here and in the next headline — holler if you'd rather I not.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Sounds good!

4. Remove the user for each combination of space and role, by running:

```sh
cf unset-space-role <email> <org> <space> <role>
Copy link
Contributor

Choose a reason for hiding this comment

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

Safe to assume the username will always be an email address? email and username are functionally equivalent at the moment but conceivably might not always be. (Same question applies in line 128.)

Copy link
Contributor

Choose a reason for hiding this comment

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

It's already used elsewhere in this file, so not necessary to discuss at the moment.

Copy link
Contributor

Choose a reason for hiding this comment

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

For regular users, it's safe to assume it will always be user's e-mail address. For specially created users like the brokered accounts, it would be weird things (in that a UAA UUID)


If you're an Org Manager or Space Manager, go to the space with the teammate you want to remove.

On the Space page, scroll down to the "Space users" section. This has a list of all the space users. Click the "Remove User From Space" button.
Copy link
Contributor

Choose a reason for hiding this comment

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

👾

Copy link
Contributor

Choose a reason for hiding this comment

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

@rememberlenny this currently doesn't exist on the Space users page.

Copy link
Contributor

@fureigh fureigh left a comment

Choose a reason for hiding this comment

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

One question (re: who has access to the dashboard). All else looks good. Thanks!


If you are an Org Manager or Space Manager, you can remove teammates from orgs and spaces respectively.

{{% dashboard %}}
Copy link
Contributor

Choose a reason for hiding this comment

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

Do Space Managers have access to the dashboard? I ask because of line 22.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@fureigh Org Managers are currently the only people who can invite users. The reference on line 22 is still correct. All users have access to the dashboard. There is a ticket that Adam is working on that would require a change to the documentation. In regards to my PR that adds the remove user functionality/notice, this is correct.

Copy link
Contributor

@jcscottiii jcscottiii left a comment

Choose a reason for hiding this comment

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

Not sure what you want to do about the space users page.

gboone
gboone previously approved these changes Jul 24, 2017
Copy link
Contributor

@gboone gboone left a comment

Choose a reason for hiding this comment

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

When I grow up I want to be a space manager. Sounds like a cool job. Joking aside, this looks good from my end. I trust the team to work out @fureigh and @jcscottiii's questions. LMK if you want a review again once you're set or if you want my help figuring out how to resolve them.

@brittag
Copy link
Contributor

brittag commented Jul 25, 2017

This will be very helpful! Recommendations:

  • Look for and cut unnecessary sentences and words, since this is a long page and people want to get to their task. Example: "On the Organization page, scroll down to the “Organization users” section. This has a list of all the organization users." -> "On the Organization page, go down to “Organization users”."
  • Speak to the user consistently as "you": "they must first be removed from any of the organization’s spaces first" -> "you first need to remove them from the organization's spaces".

@suprenant suprenant dismissed fureigh’s stale review July 25, 2017 16:10

Requested changes have been addressed

@rememberlenny rememberlenny merged commit d20443d into master Jul 25, 2017
@rememberlenny rememberlenny deleted the lkb-remove_user branch July 25, 2017 16:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants