Skip to content

Commit 9d7b80f

Browse files
authored
(docs) update docs/_docs/interface.md (#337)
- correct spelling/grammar/punctuation * do not split infinitive * article agreement
1 parent 378a2d7 commit 9d7b80f

File tree

1 file changed

+23
-21
lines changed

1 file changed

+23
-21
lines changed

docs/_docs/interface.md

Lines changed: 23 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,13 @@ toc: false
88

99
## Home
1010

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

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

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

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

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

26-
2726
## Collections
2827

2928
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:
@@ -42,18 +41,18 @@ Each collection also has usage instructions.
4241

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

45-
4644
### Add a Container
47-
A view has been added for users with permission to directly upload a container to a collection! You
45+
46+
A view has been added for users with permission to upload a container to a collection directly! You
4847
can do this by clicking the "+" in the menu above the container table. here is what the upload page looks like:
4948

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

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

5453
## User Profile
5554

56-
From the user settings menu you can quickly grab your user token, which will allow you
55+
From the user settings menu, you can quickly grab your user token, which will allow you
5756
to do authenticated pushes using Singularity.
5857

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

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

72-
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.
71+
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.
7372

7473
### Badges
75-
Recently added, you can get a badge to link to your collection
74+
75+
Recently added, you can get a badge to link to your collection.
7676

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

7979
### Users
80+
8081
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:
8182

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

84-
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.
85+
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.
8586

8687
### Danger Zone
87-
And of course if you need to delete, the settings page has a Danger Zone. Be careful!
88+
89+
And of course, if you need to delete, the settings page has a Danger Zone. Be careful!
8890

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

@@ -112,25 +114,25 @@ For example, here is the treemap.
112114

113115
## Teams
114116

115-
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.
117+
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.
116118

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

119-
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":
121+
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":
120122

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

123-
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.
125+
The interface will give you a link to send to your colleague to invite them to the team. Once used, it will expire.
124126

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

127-
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.
129+
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.
128130

129131
### Admin Control of Teams
130132

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

135137
```python
136138
# $ docker exec -it sregistry_uwsgi_1 bash
@@ -152,5 +154,5 @@ collection.owners.add(user)
152154
```
153155

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

0 commit comments

Comments
 (0)