Skip to content

Commit

Permalink
update docs (#33)
Browse files Browse the repository at this point in the history
* update docs

* <bot> update requirements.txt

Co-authored-by: github-actions <[email protected]>
  • Loading branch information
dsschult and github-actions authored Jul 20, 2022
1 parent 80cc4eb commit 1db164f
Show file tree
Hide file tree
Showing 7 changed files with 10 additions and 18 deletions.
Binary file removed docs/images/keycloak_account.png
Binary file not shown.
Binary file added docs/images/profile.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/images/registration.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
11 changes: 4 additions & 7 deletions docs/new_user.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,18 +5,15 @@ hide:

# New User Registration

New users should register through
[https://user-management.icecube.aq/register](https://user-management.icecube.aq/register).
New users should register through a link provided by their institution lead.

Here is an example of the registration page:

![registration](images/registration.png)

Most fields are explanatory. The Author List Name should be filled in
if you should appear on the author list, but can be ignored.
The email address should be an external email account (maybe your local
institution account) that can receive password resets and other
account-oriented emails.
Most fields are explanatory. The email address should be an external
email account (maybe your local institution account) that can receive
password resets and other account-oriented emails.

## Upcoming Actions

Expand Down
14 changes: 5 additions & 9 deletions docs/user_profile.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,10 @@ hide:
# User Profile

Basic information about a user, such as their name and external email address,
can be edited by going to your
[Keycloak Account](https://keycloak.icecube.wisc.edu/auth/realms/IceCube/account/).

[![account](images/keycloak_account.png)](https://keycloak.icecube.wisc.edu/auth/realms/IceCube/account/)

---

For institution and group information, go to the
can be edited by going to your profile in the
[User Management](user-management.icecube.aq/) web application.
Institution and group information is available at the same link.

Here is an example of the profile page:

[![profile](images/profile_all.png)](user-management.icecube.aq/)
![profile](images/profile.png)
2 changes: 1 addition & 1 deletion requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ pyjwt[crypto]==2.4.0
# via
# wipac-keycloak-rest-services
# wipac-rest-tools
pymongo==4.1.1
pymongo==4.2.0
# via motor
requests==2.28.1
# via
Expand Down
1 change: 0 additions & 1 deletion user_mgmt/static/routes/home.js
Original file line number Diff line number Diff line change
Expand Up @@ -411,7 +411,6 @@ export default {
<div v-else class="welcome">
<h3>Welcome to the IceCube Neutrino Observatory identity management console.</h3>
<p>Existing users should <login :keycloak="keycloak"></login>.</p>
<p>New users should <router-link :to="{name: 'register'}">register</router-link>.</p>
</div>
</article>`
}
Expand Down

0 comments on commit 1db164f

Please sign in to comment.