Skip to content

Commit

Permalink
(docs) update docs/_docs/interface.md (#337)
Browse files Browse the repository at this point in the history
- correct spelling/grammar/punctuation
  * do not split infinitive
  * article agreement
  • Loading branch information
vladdoster authored Jan 16, 2021
1 parent 378a2d7 commit 9d7b80f
Showing 1 changed file with 23 additions and 21 deletions.
44 changes: 23 additions & 21 deletions docs/_docs/interface.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,13 @@ toc: false

## Home

When you browse to the root of your registry, it's a fairly expected interface with
links to collections and documentation. Here is what we see for the default "Tacosaurus Computing Center"
When you browse to your registry's root, it's a fairly expected interface with
links to collections and documentation. Here is what we see for the default "Tacosaurus Computing Center."

![teams.png](../assets/img/interface/home.png)

When you sign in with social authentication (e.g., GitHub) you are asked to sign standard terms of service.
This basically says that the software is provided for you, free to use, and you are responsible
When you sign in with social authentication (e.g., GitHub), you first must sign the standard terms of service (TOS).
The TOS asserts that the software is provided for you, free to use, and you are responsible
for taking care of your registry and are accountable for the containers within it.

![teams.png](../assets/img/interface/terms.png)
Expand All @@ -23,7 +23,6 @@ When you agree, the robots welcome you!

![teams.png](../assets/img/interface/terms-welcome.png)


## Collections

A collection is a set of containers under the same namespace. For example, `dinosaur/avocado` and `dinosaur/banana` could be two containers in the `dinosaur` collection. You can browse all collections in the main collection view:
Expand All @@ -42,18 +41,18 @@ Each collection also has usage instructions.

![usage.png](../assets/img/interface/usage.png)


### Add a Container
A view has been added for users with permission to directly upload a container to a collection! You

A view has been added for users with permission to upload a container to a collection directly! You
can do this by clicking the "+" in the menu above the container table. here is what the upload page looks like:

![upload.png](../assets/img/upload.png)

This uploads directly to nginx via the [nginx upload module](https://www.nginx.com/resources/wiki/modules/upload/), so it should be pretty speedy.
This uploads directly to NGINX via the [nginx-upload-module](https://www.nginx.com/resources/wiki/modules/upload/), so it should be pretty speedy.

## User Profile

From the user settings menu you can quickly grab your user token, which will allow you
From the user settings menu, you can quickly grab your user token, which will allow you
to do authenticated pushes using Singularity.

![teams.png](../assets/img/interface/token.png)
Expand All @@ -69,22 +68,25 @@ see as the first link in the menu at the top of the table. The most likely actio

![team-settings.png](../assets/img/team-settings.png)

For example, if my lab has a set of users on sregistry and we intend to build images together, we would make a team for our lab, and then easily find one another to manage access to images.
For example, if my lab has a set of users on sregistry and we intend to build images together, we would make the team for our lab and easily find one another to manage access to images.

### Badges
Recently added, you can get a badge to link to your collection

Recently added, you can get a badge to link to your collection.

![assets/img/badges.png](../assets/img/badges.png)

### Users

You might want to give other users control of your collection (to push and pull and generally manage), and these are called **owners**. You might also want to give some users pull access, most relevant if your collection is private. You can do that in the "Contributors" tab of the settings page:

![assets/img/team-settings.png](../assets/img/team-settings.png)

Remember that you can only choose to add individuals that are part of one of your teams. This means that you should generally make a team first.
Remember that you can only choose to add individuals that are part of one of your teams. This means that you should generally make the team first.

### Danger Zone
And of course if you need to delete, the settings page has a Danger Zone. Be careful!

And of course, if you need to delete, the settings page has a Danger Zone. Be careful!

![assets/img/danger.png](../assets/img/danger.png)

Expand Down Expand Up @@ -112,25 +114,25 @@ For example, here is the treemap.

## Teams

Singularity Registry Server allows registry staff (and if the administrators allow it) authenticated users to create teams, or groups of users that want to collaborate on container collections together.
Singularity Registry Server allows registry staff (and if the administrators allow it) authenticated users to create teams or groups of users that want to collaborate on container collections together.

![teams.png](../assets/img/teams.png)

If you are allowed to create and manage teams (see the setup page section about [teams](/sregistry/setup#teams) for information about this) the team permission level determines how others are added to the team. If a team is **open**, then anyone can join. If it's **invite** only, then you need to generate an invitation. To do this, you can navigate to your Team page, and click the button to "Invite User":
If you are allowed to create and manage teams (see the setup page section about [teams](/sregistry/setup#teams) for information about this), the team permission level determines how others are added to the team. If a team is **open**, then anyone can join. If it's **invite** only, then you need to generate an invitation. To do this, you can navigate to your Team page and click the button to "Invite User":

![team-invite.png](../assets/img/team-invite.png)

The interface will give you a link to send to your colleague to join him or her to the team. Once used, it will expire.
The interface will give you a link to send to your colleague to invite them to the team. Once used, it will expire.

![team-invite-link.png](../assets/img/team-invite-link.png)

Membership in teams is important because when you add another user as a collaborator to one of your collections (either an owner ot member) they must be part of one of your teams.
Membership in teams is essential because when you add another user as a collaborator to one of your collections (either an owner or member), they must be part of one of your teams.

### Admin Control of Teams

While Singularity Registry server doesn't directly allow administrators to add any users to be part of a
collection contributors or owners (this we believe should be up to the collection owners), it is possible to do this
programmatically if it's absolutely necessary. Here is an example:
While the Singularity Registry server doesn't directly allow administrators to add any users to be part of a
collection of contributors or owners (this we believe should be up to the collection owners), it is possible to do this
programmatically if it's necessary. Here is an example:

```python
# $ docker exec -it sregistry_uwsgi_1 bash
Expand All @@ -152,5 +154,5 @@ collection.owners.add(user)
```

It is the philosophy of this developer that collection owners should be responsible for this,
and thus the "Teams" feature is advocated for use as it explicitly states "I am creating
and thus the "Teams" feature is advocated for use as it explicitly states, "I am creating
this team of trusted users to add to my collection."

0 comments on commit 9d7b80f

Please sign in to comment.