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

Set up your community permissions #530

Closed
wants to merge 2 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions config/en/mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,7 @@ markdown_extensions:
- pymdownx.details
- pymdownx.keys
- pymdownx.tilde
- pymdownx.caret
- pymdownx.smartsymbols
- pymdownx.superfences
- pymdownx.tabbed:
Expand Down Expand Up @@ -199,6 +200,7 @@ nav:
- Create and administer communities:
- Create a Status Community: status-communities/create-a-status-community.md
- Customize your community: status-communities/customize-your-community.md
- Set up your community permissions: status-communities/set-up-your-community-permissions.md
- Kick or ban someone from your community: status-communities/kick-or-ban-someone-from-your-community.md
- Status Web Communities:
- Use a throwaway profile in Status Web: status-communities/use-a-throwaway-profile-in-status-web.md
Expand Down
16 changes: 16 additions & 0 deletions docs/en/status-communities/co-manage-your-status-community.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
id: 523
revision: 0
language: en
hide:
- navigation
---

# Co-manage your Status Community

:octicons-tools-24: In progress

!!! note ""
We're working on this content.

--8<-- "includes/urls-en.txt"
2 changes: 1 addition & 1 deletion docs/en/status-communities/create-a-status-community.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ After you create a community, you can customize its settings at any time.
=== "Desktop"

1. From the navigation sidebar, click your community.
1. On top of the channel sidebar, click your community logo.
1. On top of the channels sidebar, click your community logo.
jorge-campo marked this conversation as resolved.
Show resolved Hide resolved
1. Click :desktop-overview: **Overview**.
1. Expand the window and click **Edit Community**.
1. Edit your community look-and-feel, [additional settings](#configure-additional-settings) or [community rules](#describe-your-community-and-its-rules).
Expand Down
1 change: 1 addition & 0 deletions docs/en/status-communities/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ Create your community, set up private channels or join others' communities and c

- [**Create** a Status community][create-a-status-community]
- [**Kick or ban** someone from your community][kick-or-ban-someone-from-your-community]
- [Set up your **community permissions**][set-up-your-community-permissions]

## Status Web Communities

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
id: 522
revision: 0
language: en
hide:
- navigation
---

# Set up private and public communities

:octicons-tools-24: In progress

!!! note ""
We're working on this content.

--8<-- "includes/urls-en.txt"
66 changes: 66 additions & 0 deletions docs/en/status-communities/set-up-your-community-permissions.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
---
id: 355
revision: 0
language: en
hide:
- navigation
---

# Set up your community permissions

!!! note ""
Currently, you can only configure community permissions using Status desktop.
jorge-campo marked this conversation as resolved.
Show resolved Hide resolved

In Status Communities, owners can configure community permissions using tokens. Tokens are digital assets in a blockchain (such as Ethereum), including virtual coins, collectibles and domain names.
jorge-campo marked this conversation as resolved.
Show resolved Hide resolved

When configuring permissions based on tokens, certain actions within a specific community are only available to users who own a particular token. For instance, owners can [restrict access to their community][set-up-private-and-public-communities] or [delegate admin functions][co-manage-your-status-community] to token holders.
jorge-campo marked this conversation as resolved.
Show resolved Hide resolved

!!! note
In Status, your tokens are securely stored in your [Status Wallet][status-wallet-your-quick-start-guide].

## What to expect

- Using token-based permissions, community owners can restrict community access and actions to specific people based on token requirements.
- Only the community owner can add, edit or delete community-level permissions.
- You configure community permissions in the same way you [configure channel permissions][configure-channel-permissions]. The only difference is the permissions you grant, either community-level (Become admin or Become member) or channel-level (Moderate, View and post or View only).
- Use the Become member permission to [restrict access to your community][set-up-private-and-public-communities]. Use the Become admin permission to [delegate admin functions][co-manage-your-status-community] to someone.
jorge-campo marked this conversation as resolved.
Show resolved Hide resolved

## Add community permissions

Community owners configure permissions using three different variables: `Who holds` (optional), `Is allowed to` and `In`. For each variable, follow the same procedure using the table below for reference.
jorge-campo marked this conversation as resolved.
Show resolved Hide resolved

=== "Desktop"

1. From the navigation sidebar, click your community.
1. On top of the channels sidebar, click your community logo and then, click **Permissions**.
1. Click **Add permission** to start from scratch or click :desktop-duplicate: **Duplicate** to start from an existing permission.
1. For the **Who holds**, **Is allowed to** and **In** variables, click :desktop-plus: **Add** next to the variable and choose your values. Use the table below for reference.
jorge-campo marked this conversation as resolved.
Show resolved Hide resolved
1. Optionally, check :desktop-hide: **Hide permission** to hide this permission from members who don't meet the requirements.
1. Click **Create permission**. The new permission takes effect immediately.

| Variable | Description | Options |
|:--------------|:-------------------------------------------------------------------------------|:--------------------------------------|
| Who holds (optional) | The tokens and amounts (for assets and collectibles) someone needs to hold. | Assets, Collectibles, ENS |
| Is allowed to | The community role that you assign to someone. | :desktop-admin: Become admin, :desktop-member: Become member |
| In | The community this permission applies to. | Community |

- If you turn the **Who holds** option off, the permission isn't bound to a token. This option only applies to channel-level permissions.
- Tokens are linked by an `AND` operator. This means the new permission takes effect when the holder owns all the tokens. If you want to use the `OR` operator instead, create additional permissions.
jorge-campo marked this conversation as resolved.
Show resolved Hide resolved
- You can combine a maximum of five tokens in a single permission.
jorge-campo marked this conversation as resolved.
Show resolved Hide resolved
- You can create a maximum of five different `Become member` community-level permissions.

## Edit community permissions

1. From the navigation sidebar, click your community.
1. On top of the channels sidebar, click your community logo and then, click **Permissions**.
1. In the permission you want to edit, click :desktop-edit: **Edit**.
1. To customize the permission, follow the steps in the [Add community permissions](#add-community-permissions) section.

## Delete community permissions

1. From the navigation sidebar, click your community.
1. On top of the channels sidebar, click your community logo and then, click **Permissions**.
1. In the permission you want to delete, click :desktop-delete: **Delete**.
1. Click **Delete permission** to confirm your action.

--8<-- "includes/urls-en.txt"
7 changes: 5 additions & 2 deletions includes/urls-en.txt
Original file line number Diff line number Diff line change
Expand Up @@ -55,17 +55,20 @@
[about-the-community-history-service]: /en/status-communities/about-the-community-history-service
[backup-your-community-key]: /en/status-communities/backup-your-community-key
[channels-your-quick-start-guide]: /en/status-communities/channels-your-quick-start-guide
[create-a-channel]: /en/status-communities/create-a-channel
[create-a-status-community]: /en/status-communities/create-a-status-community
[co-manage-your-status-community]: /en/status-communities/co-manage-your-status-community
[configure-channel-permissions]: /en/status-communities/configure-channel-permissions
[configure-your-community-permissions]: /en/status-communities/configure-your-community-permissions
[create-a-channel]: /en/status-communities/create-a-channel
[create-a-status-community]: /en/status-communities/create-a-status-community
[delete-a-channel]: /en/status-communities/delete-a-channel
[how-to-use-communities-your-quick-start-guide]: /en/status-communities/how-to-use-communities-your-quick-start-guide
[invite-people-to-a-status-community]: /en/status-communities/invite-people-to-a-status-community
[join-a-channel]: /en/status-communities/join-a-channel
[join-a-status-community]: /en/status-communities/join-a-status-community
[kick-or-ban-someone-from-your-community]: /en/status-communities/kick-or-ban-someone-from-your-community
[set-up-your-communitys-approval-options]: /en/status-communities/set-up-your-communitys-approval-options
[set-up-your-community-permissions]: /en/status-communities/set-up-your-community-permissions
[set-up-private-and-public-communities]: /en/status-communities/set-up-private-and-public-communities
[understand-throwaway-profiles-in-status-web]: /en/status-communities/understand-throwaway-profiles-in-status-web
[understand-token-requirements-in-channels]: /en/status-communities/understand-token-requirements-in-channels
[use-a-throwaway-profile-in-status-web]: /en/status-communities/use-a-throwaway-profile-in-status-web
Expand Down
5 changes: 5 additions & 0 deletions overrides/.icons/desktop/admin.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
5 changes: 5 additions & 0 deletions overrides/.icons/desktop/hide.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
5 changes: 5 additions & 0 deletions overrides/.icons/desktop/member.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.