Skip to content

Commit 6d9447d

Browse files
Updated documentation, reflecting the organization=>group change
1 parent 050a0fa commit 6d9447d

12 files changed

Lines changed: 307 additions & 292 deletions

File tree

docs/triply-api/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ https://api.INSTANCE/datasets/ACCOUNT/DATASET/
7777
Upper-case letter words must be replaced by the following values:
7878

7979
- `INSTANCE` :: The host name of the TriplyDB instance that you want to use.
80-
- `ACCOUNT` :: The name of a specific user or a specific organization.
80+
- `ACCOUNT` :: The name of a specific user or a specific group.
8181
- `DATASET` :: The name of a specific dataset.
8282

8383
Here is an example of a URI path that points to the Triply API for the Pokémon dataset:

docs/triply-db-getting-started/admin-settings-pages/index.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ The general overview gives an insight into the software version of the instance.
2020

2121
### Accounts overview
2222

23-
The accounts overview shows how many organizations and users are in this instance. The organizations and users are shown in a counter if no limit is set. If a limit is set on the number of organizations and/or users of the instance a gauge is shown.
23+
The accounts overview shows how many groups and users are in this instance. The groups and users are shown in a counter if no limit is set. If a limit is set on the number of groups and/or users of the instance a gauge is shown.
2424

2525

2626
### Data overview
@@ -126,7 +126,7 @@ For editing the side-wide prefixes follow the next steps:
126126

127127
## Roles page
128128

129-
The roles page allows administrators to manage the roles that can be assigned to organization members. Roles define which actions organization members can perform within an organization. Roles only apply to organization members, not to personal accounts.
129+
The roles page allows administrators to manage the roles that can be assigned to group members. Roles define which actions group members can perform within a group. Roles only apply to group members, not to personal accounts.
130130

131131
The roles page is accessible by clicking on the "Admin settings" link in the user menu (top-right corner) and clicking the "Roles" tab.
132132

@@ -137,10 +137,10 @@ TriplyDB includes two built-in system roles that cannot be deleted:
137137

138138
<dl>
139139
<dt><code>owner</code></dt>
140-
<dd>Full access to all account resources and settings, including the ability to manage organization members and their roles.</dd>
140+
<dd>Full access to all account resources and settings, including the ability to manage group members and their roles.</dd>
141141

142142
<dt><code>member</code></dt>
143-
<dd>Can manage resources (datasets, queries, stories) but cannot manage organization members or delete the organization.</dd>
143+
<dd>Can manage resources (datasets, queries, stories) but cannot manage group members or delete the group.</dd>
144144
</dl>
145145

146146

@@ -165,7 +165,7 @@ Custom roles can be edited or deleted at any time from the roles page using the
165165

166166
### Assigning roles
167167

168-
Roles are assigned to organization members in the member settings of each organization. Organization members with sufficient permissions (such as owners) can assign roles to other members. See [Organization.addMember()](../../triplydb-js/organization/index.md#organizationaddmemberuser-user-role-role) for how to assign roles programmatically.
168+
Roles are assigned to group members in the member settings of each group. Group members with sufficient permissions (such as owners) can assign roles to other members. See [Group.addMember()](../../triplydb-js/group/index.md#groupaddmemberuser-user-role-role) for how to assign roles programmatically.
169169

170170

171171
## Account overview page
@@ -180,7 +180,7 @@ The filters on top of the table can be used to filter the following columns:
180180
<dd>The name of the account, you can order the table based on the alphanumeric ordering, and filter based on the sequence of characters appearing in the filter. The name is also a URL that brings you to the location of the account. </dd>
181181

182182
<dt>Type</dt>
183-
<dd>Type of the account, this can either be 'Organization' or 'User'. In the filter you can select a specific account type or 'All' account types.</dd>
183+
<dd>Type of the account, this can either be 'Group' or 'User'. In the filter you can select a specific account type or 'All' account types.</dd>
184184

185185
<dt>Display name</dt>
186186
<dd>The display name of the account, often an account has both a name and a display name. The display name is not limited to a specific set of characters, as it is not used as an URL. You can order the table based on the alphanumeric ordering, and filter based on the sequence of characters appearing in the filter. </dd>
@@ -214,7 +214,7 @@ For each account you can execute the following actions:
214214

215215
<dl>
216216
<dt>Open account settings</dt>
217-
<dd>For each account, there is a button such that the administrator can directly go to the account settings of the user or organization. The account settings are behind the `cogwheel` button. </dd>
217+
<dd>For each account, there is a button such that the administrator can directly go to the account settings of the user or group. The account settings are behind the `cogwheel` button. </dd>
218218
</dl>
219219

220220

@@ -227,15 +227,15 @@ The type of account can be observed based on the following icons:
227227

228228
| **Icon** | **Account type** |
229229
| --------------------- | ---------------- |
230-
| ![](../../assets/organization.png) | organization |
230+
| ![](../../assets/organization.png) | group |
231231
| ![](../../assets/user.png) | user |
232232

233233

234234
### Create a new user
235235

236236
New users can only be created by administrators by performing the following steps:
237237

238-
1. Click on the “Admin settings” link in the user menu (top-right corner) and click the “Accounts” tab. This brings up an overview of all users and organizations on the TriplyDB instance.
238+
1. Click on the “Admin settings” link in the user menu (top-right corner) and click the “Accounts” tab. This brings up an overview of all users and groups on the TriplyDB instance.
239239

240240
2. Click the “Add user” button.
241241

docs/triply-db-getting-started/data-stories/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,8 @@ As shown in the image below, in the top right corner of the page, there is a men
1818

1919
- **Story settings**: Here you can change the title and the access level of your story.
2020
- **Change banner**: Here you can change the banner, just choose an image that you want as your banner (wide images work best).
21-
- **Copy**: To copy the story to a different user or organization.
22-
- **Transfer**: To transfer the story to a different user or organization.
21+
- **Copy**: To copy the story to a different user or group.
22+
- **Transfer**: To transfer the story to a different user or group.
2323
- **Embed**: HTML to embed the story in a web page using an iFrame.
2424
- **Print**: Dialog and print options to print the story.
2525
- **Delete**: To delete the story.

docs/triply-db-getting-started/reference/index.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -23,25 +23,25 @@ The Access Level control (see [Figure 1](#fig-access-level-control)) is availabl
2323

2424
### Access Level meaning
2525

26-
What an Access Level means, depends on whether content belongs to a user or to an organization. The following table contains the meaning of the Access Levels for content that belongs to a user:
26+
What an Access Level means, depends on whether content belongs to a user or to a group. The following table contains the meaning of the Access Levels for content that belongs to a user:
2727

2828
| **Icon** | **Access Level** | **Meaning** |
2929
| ------------------------------ | ---------------- | --------------------------------------------------------------------------------- |
3030
| ![](../../assets/private.png) | Private | Content is only accessible to you. |
3131
| ![](../../assets/internal.png) | Internal | Content is accessible to anyone who is logged into the same TriplyDB environment. |
3232
| ![](../../assets/public.png) | Public | Content is accessible to anyone on the Internet. |
3333

34-
The following table contains the meaning of the Access Levels for content that belongs to an organization:
34+
The following table contains the meaning of the Access Levels for content that belongs to a group:
3535

3636
| **Icon** | **Access Level** | **Meaning** |
3737
| ------------------------------ | ---------------- | --------------------------------------------------------------------------------- |
38-
| ![](../../assets/private.png) | Private | Content is only accessible to organization members. |
38+
| ![](../../assets/private.png) | Private | Content is only accessible to group members. |
3939
| ![](../../assets/internal.png) | Internal | Content is accessible to anyone who is logged into the same TriplyDB environment. |
4040
| ![](../../assets/public.png) | Public | Content is accessible to anyone on the Internet. |
4141

4242
Access Levels cannot be specified for the following content. This means that this content is always publicly accessible:
4343

44-
- Organizations, including their metadata and members.
44+
- Groups, including their metadata and members.
4545
- Users, including their metadata.
4646

4747
### Access Level dependencies
@@ -65,9 +65,9 @@ These access levels are often used for the following workflow:
6565

6666
## Roles
6767

68-
TriplyDB uses roles to control what actions organization members can perform. While [Access Levels](#access-levels) control *who can see* content (visibility), roles control *what actions* members are allowed to take within an organization.
68+
TriplyDB uses roles to control what actions group members can perform. While [Access Levels](#access-levels) control *who can see* content (visibility), roles control *what actions* members are allowed to take within a group.
6969

70-
Roles only apply to organization members. Personal user accounts are not affected by roles.
70+
Roles only apply to group members. Personal user accounts are not affected by roles.
7171

7272
### System roles
7373

@@ -76,13 +76,13 @@ Two system roles are always available:
7676
| **Role** | **Description** |
7777
| ------------ | ---------------------------------------------------------------------------------------------------- |
7878
| `owner` | Full access to all account resources and settings, including member management. |
79-
| `member` | Can manage resources (datasets, queries, stories) but cannot manage members or delete the organization. |
79+
| `member` | Can manage resources (datasets, queries, stories) but cannot manage members or delete the group. |
8080

8181
### Custom roles
8282

83-
Administrators can create custom roles with a specific subset of permissions. This allows organizations to grant exactly the level of access that is appropriate for each member. For example, a custom role could allow read access to all datasets without the ability to create new ones, or grant write access without the ability to manage SPARQL services.
83+
Administrators can create custom roles with a specific subset of permissions. This allows groups to grant exactly the level of access that is appropriate for each member. For example, a custom role could allow read access to all datasets without the ability to create new ones, or grant write access without the ability to manage SPARQL services.
8484

85-
Custom roles are configured by administrators in the [Admin Settings](../admin-settings-pages/index.md#roles-page). Roles are assigned to members in each organization's member settings.
85+
Custom roles are configured by administrators in the [Admin Settings](../admin-settings-pages/index.md#roles-page). Roles are assigned to members in each group's member settings.
8686

8787
### API token permissions
8888

docs/triply-db-getting-started/viewing-data/index.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -137,7 +137,7 @@ It is sometimes useful to share a SPARQL query with somebody else, or to have a
137137

138138
### Transfer a SPARQL query
139139

140-
The SPARQL queries could be transferred to another account or an organization. To do that, go to the setting field at the query page,
140+
The SPARQL queries could be transferred to another account or a group. To do that, go to the setting field at the query page,
141141

142142
![Transfer a SPARQL query](../../assets/where-find-transfer.png)
143143

@@ -149,19 +149,19 @@ and then choose where the SPARQL query should be moved to:
149149

150150
![Transfer a SPARQL query](../../assets/transfer-to-organization.png)
151151

152-
After the destination is set you would be redirected to the SPARQL query new page. The SPARQL query could be transferred from an account to an organization and vice versa.
152+
After the destination is set you would be redirected to the SPARQL query new page. The SPARQL query could be transferred from an account to a group and vice versa.
153153

154154
### Copy a SPARQL query
155155

156-
Users can copy SPARQL queries to another account or an organization. To do that, click on three dots in the upper right corner of the query and choose the copy option:
156+
Users can copy SPARQL queries to another account or a group. To do that, click on three dots in the upper right corner of the query and choose the copy option:
157157

158158
![Copy query](../../assets/copyQuery.png)
159159

160160
Then, choose where the SPARQL query should be moved to:
161161

162-
![Select organization](../../assets/selectOrganization.png)
162+
![Select group](../../assets/selectOrganization.png)
163163

164-
After setting the destination, you will be redirected to the SPARQL query new page. The SPARQL query can be copied from an account to an organization and vice versa.
164+
After setting the destination, you will be redirected to the SPARQL query new page. The SPARQL query can be copied from an account to a group and vice versa.
165165

166166
## ElasticSearch
167167

docs/triplydb-js/account/index.md

Lines changed: 18 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
# Account
44

5-
Instances of the `Account` class denote TriplyDB accounts. Accounts can be either organizations ([`Organization`](../organization/index.md#organization)) or users ([`User`](../user/index.md#user)).
5+
Instances of the `Account` class denote TriplyDB accounts. Accounts can be either groups ([`Group`](../group/index.md#group)) or users ([`User`](../user/index.md#user)).
66

77
Account objects are obtained by calling the following method:
88

@@ -39,7 +39,7 @@ The `metadata` argument optionally specifies the access level and other importan
3939
<p>The access level of the dataset. The following values are supported:</p>
4040
<dl>
4141
<dt><code>'private'</code> (default)</dt>
42-
<dd>The dataset can only be accessed by organization members.</dd>
42+
<dd>The dataset can only be accessed by group members.</dd>
4343
<dt><code>'internal'</code> </dt>
4444
<dd>The dataset can only be accessed by users that are logged into the TriplyDB server.</dd>
4545
<dt><code>'public'</code></dt>
@@ -309,36 +309,37 @@ const newStory = await user.addStory('name-of-story', {
309309
```
310310

311311

312-
## Account.asOrganization()
312+
<a id="accountasorganization"></a>
313+
## Account.asGroup()
313314

314-
Casts the TriplyDB account object to its corresponding organization object.
315+
Casts the TriplyDB account object to its corresponding group object.
315316

316-
Class [Organization](../organization/index.md#organization) is a specialization of class [Account](#account).
317+
Class [Group](../group/index.md#group) is a specialization of class [Account](#account).
317318

318-
Calling this method on an `Organization` object does nothing.
319+
Calling this method on a `Group` object does nothing.
319320

320321
### Examples
321322

322-
The following snippet retrieves the account named `'Triply'` and casts it to an organization:
323+
The following snippet retrieves the account named `'Triply'` and casts it to a group:
323324

324325
```ts
325326
const account = await triply.getAccount('Triply')
326-
const organization = account.asOrganization()
327+
const group = account.asGroup()
327328
```
328329

329330
### Alternatives
330331

331-
This method is not needed if the organization is directly retrieved with the specialization method [`App.getOrganization(name: string)`](../app/index.md#appgetorganizationname-string).
332+
This method is not needed if the group is directly retrieved with the specialization method [`App.getGroup(name: string)`](../app/index.md#appgetgroupname-string).
332333

333334
The following snippet returns the same result as the above example, but in a more direct way:
334335

335336
```ts
336-
const organization = await triply.getOrganization('Triply')
337+
const group = await triply.getGroup('Triply')
337338
```
338339

339340
### See also
340341

341-
This method returns an organization object. See class [Organization](../organization/index.md#organization) for an overview of the methods that can be called on such objects.
342+
This method returns a group object. See class [Group](../group/index.md#group) for an overview of the methods that can be called on such objects.
342343

343344

344345
## Account.asUser()
@@ -370,7 +371,7 @@ const user = await triply.getUser()
370371

371372
### See also
372373

373-
This method returns an organization object. See class [Organization](../organization/index.md#organization) for an overview of the methods that can be called on such objects.
374+
This method returns a user object. See class [User](../user/index.md#user) for an overview of the methods that can be called on such objects.
374375

375376

376377
## Account.ensureDataset(name: string, metadata?: object)
@@ -490,13 +491,13 @@ The information object for accounts includes the following keys:
490491
<dd>An array containing the pinned items (datasets, stories and queries) for the account.</dd>
491492

492493
<dt><code>type</code></dt>
493-
<dd>The account type: either <code>organization</code> or <code>user</code>.</dd>
494+
<dd>The account type: either <code>org</code> (for a group) or <code>user</code>. The <code>org</code> value is preserved for backwards compatibility — groups were previously called organizations.</dd>
494495

495496
<dt><code>role</code></dt>
496497
<dd>The role of the account</dd>
497498

498499
<dt><code>orgs</code></dt>
499-
<dd>An array of organizations of which the account is a member.</dd>
500+
<dd>An array of groups of which the account is a member.</dd>
500501

501502
<dt><code>Email address</code></dt>
502503
<dd>The email address of the account.</dd>
@@ -549,7 +550,7 @@ A pinned item is an item that is displayed in a prominent way on the account web
549550

550551
### Order considerations
551552

552-
The order in which the pinned datasets are returned reflects the order in which they appear on the organization homepage (from top-left to bottom-right).
553+
The order in which the pinned datasets are returned reflects the order in which they appear on the group homepage (from top-left to bottom-right).
553554

554555
### Examples
555556

@@ -939,8 +940,8 @@ async (ctx) => {
939940
// Specify the environment variable, if necessary
940941
const _dataset =
941942
process.env['MODE'] === 'Production'
942-
? (await app.triplyDb.getOrganization(organization)).getDataset(dataset)
943-
: (await app.triplyDb.getUser()).getDataset(organization + '-' + dataset)
943+
? (await app.triplyDb.getGroup(group)).getDataset(dataset)
944+
: (await app.triplyDb.getUser()).getDataset(group + '-' + dataset)
944945

945946
// Update the display name
946947
if (displayName) await (await _dataset).update({ displayName })

0 commit comments

Comments
 (0)