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

Create user.md to store user management content #1051

Merged
merged 4 commits into from
Apr 3, 2019

Conversation

ysuarez
Copy link
Contributor

@ysuarez ysuarez commented Mar 8, 2019

GitHub Issue: #1040

What does this Pull Request do?

Creates user.md to store user management content

Including sections for:

  • How to Add a User
  • How to Create a New User Role
  • How to Edit Role Permissions

What's new?

It covers the common steps for managing users in slightly more depth than older content in docs. It mentions the existence of the Drupal role of "fedoraAdmin".

How should this be tested?

A description of what steps someone could take to:

  • Review the documented steps and images to see if there is incorrect or missing information.

Additional Notes:

I think I need improvements to the content that mentions how the Drupal roles of "Administrator" and "fedoraAdmin" are meant to be used when creating or editing a Drupal user.

Here is what I wrote so far...

In the Roles section, click on the roles that the new user will need.

  • Click on "Administrator" if the new user will need to be able to run adminsitrative tasks in Drupal or Islandora 8.
  • Click on "fedoraAdmin" if the new user will need to be able to run certain tasks in Fedora. This is required by the WebAC authentication so Islandora 8 and Fedora can communicate.

Interested parties

@Islandora-CLAW/committers

Including sectiosn for:
- How to Add a User
- How to Create a New User Role
- How to Edit Role Permissions
# Managing Users

## How to Add a User
1. Log in to Drupal under admin credentials.
Copy link
Contributor

@librarychik librarychik Mar 12, 2019

Choose a reason for hiding this comment

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

Suggested change:
Log in to Drupal under admin credentials.
To:
Log in to Drupal. You will need the Administrator role to Manage Users.

1. Enter all required fields, as indicated by red asterisks, in the *Add user* page.
1. In the *Roles* section, click on the roles that the new user will need.
- Click on "Administrator" if the new user will need to be able to run adminsitrative tasks in Drupal or Islandora 8.
- Click on "fedoraAdmin" if the new user will need to be able to run certain tasks in Fedora. This is required by the WebAC authentication so Islandora 8 and Fedora can communicate.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested addition:
In the Contact Settings section. Note: the Personal contact form is selected by default.

To review/edit the permission for each role, in the *People* page click the **Permissions** tab in the set of tabs above the **Add user** button.

## How to Create a New User Role
1. Log in to Drupal under admin credentials.
Copy link
Contributor

Choose a reason for hiding this comment

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

Same as above:

Log in to Drupal. You will need the Administrator role to edit or add roles.

1. Click the blue **Add role** button to bring up the *Add role* page.
![Alt text](../assets/users_people_roles.png "Roles page")
1. Name the role in a way that it can be disambiguated from related activities or similar groups
* I.e. use the course code for a particular class of students working on a particular collection.
Copy link
Contributor

Choose a reason for hiding this comment

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

Add period after similar groups.
Change I.e. to For example:

1. Click the blue **Save** button.

## How to Edit Role Permissions
1. Log in to Drupal under admin credentials.
Copy link
Contributor

Choose a reason for hiding this comment

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

Same as above:
Log in to Drupal. You will need the Administrator role to edit permissions.

1. Click the **Roles** tab in the set of tabs above the **Add user** button.
![Alt text](../assets/users_people_roles.png "Roles page")
1. To edit the permissions for a role click the **Edit** dropdown menu to the right of a role and select **Edit Permissions** to bring up the *Edit role* page.
1. Scroll down or search for options that have an *Islandora* prefix or contain the word *Islanodra*. For example, *Islandora Access: Create terms*.
Copy link
Contributor

Choose a reason for hiding this comment

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

Spelling:
or contain the word Islanodra change to Islandora

Copy link
Contributor

@librarychik librarychik left a comment

Choose a reason for hiding this comment

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

I have no more changes to suggest.

@@ -0,0 +1,36 @@
# Managing Users
Copy link
Contributor

@Natkeeran Natkeeran Mar 14, 2019

Choose a reason for hiding this comment

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

Providing link to this documentation https://www.drupal.org/docs/user_guide/en/user-new-user.html would be useful. Perhaps like:

Further Reading:

@ysuarez
Copy link
Contributor Author

ysuarez commented Mar 14, 2019

Thank you @librarychik & @Natkeeran

I will work to implementing these changes as soon as I can today or tomorrow.

@ysuarez
Copy link
Contributor Author

ysuarez commented Mar 15, 2019

@librarychik & @Natkeeran how does it look now?

@ysuarez
Copy link
Contributor Author

ysuarez commented Mar 15, 2019

@dannylamb can you give me some feedback on this part of my content quoted below (still don't know how to properly directly quote content from my commits)....

  1. In the Roles section, click on the roles that the new user will need.
  • Click on "Administrator" if the new user will need to be able to run administrative tasks in Drupal or Islandora 8.
  • Click on "fedoraAdmin" if the new user will need to be able to run certain tasks in Fedora. This is required by the WebAC authentication so Islandora 8 and Fedora can communicate.

@dannylamb
Copy link
Contributor

@ysuarez Circling back around to all the leftover sprint tickets after a long vacay. Thanks for your patience on this one.

Instead of "run certain tasks in Fedora" I'd put "write to Fedora". If you want to update that, we'll I'm more than happy to merge.

@ysuarez
Copy link
Contributor Author

ysuarez commented Apr 3, 2019

@dannylamb I just made the change you suggested. Look it over and merge if you approve.

Copy link
Contributor

@dannylamb dannylamb left a comment

Choose a reason for hiding this comment

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

Thanks so much @ysuarez

@dannylamb dannylamb merged commit 5ef8504 into Islandora:master Apr 3, 2019
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.

4 participants