Skip to content

Commit

Permalink
docs(account-settings): update Account > Settings articles
Browse files Browse the repository at this point in the history
  • Loading branch information
rohalskyy committed Sep 2, 2024
1 parent 91762d0 commit 8f43f8c
Show file tree
Hide file tree
Showing 13 changed files with 161 additions and 94 deletions.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
185 changes: 125 additions & 60 deletions src/content/docs/crowdin/getting-started/account/settings.mdx

Large diffs are not rendered by default.

70 changes: 36 additions & 34 deletions src/content/docs/enterprise/getting-started/account/settings.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,7 @@ import securitySettings from '!/enterprise/getting-started/account/account_setti
import tokens from '!/enterprise/getting-started/account/account_settings_tokens.png';
import sudoModeConfirmingCredentials from '!/crowdin/getting-started/account/sudo_mode_confirming_credentials.png';

Manage your Crowdin Enterprise account settings by navigating to the **Account Settings** page.

To access it, click on your profile picture in the upper-right corner and select **Account Settings** from the dropdown menu.
Manage your Crowdin Enterprise account settings, including profile details, notification preferences, security settings, and more using the **Account Settings** page. To access it, click on your profile picture in the upper-right corner and select **Account Settings**.

## Personal Info

Expand Down Expand Up @@ -51,7 +49,7 @@ You can also update the following details:

## Appearance

Select the preferred Crowdin Enterprise color theme. You can choose between Light and Dark or sync it with your system settings.
Choose how Crowdin Enterprise appears on your device. You can select a Light or Dark theme or sync it with your system settings to switch automatically between day and night modes.

<Image src={themeSettings} alt="Appearance Settings" class="width-2xl" />

Expand Down Expand Up @@ -84,9 +82,9 @@ To change your password, click **Password**, enter your current password, and se

### Authenticator App

Activate Two-factor authentication to ensure an additional level of security for your Crowdin Enterprise account. Every time you log in, along with your username and password, you will use an authentication code.
Activate two-factor authentication (2FA) to add an additional layer of security to your Crowdin Enterprise account. Use an authenticator app on your mobile device or computer to generate one-time verification codes.

To enable Two-factor authentication, follow these steps:
To enable two-factor authentication, follow these steps:

<Steps>
1. Open your **Account Settings** and go to the **Security** tab.
Expand All @@ -98,27 +96,25 @@ To enable Two-factor authentication, follow these steps:

### Connected Applications

Manage the applications you've authorized to use your account. You can view a list of connected applications and revoke access if necessary.
Manage the applications you've authorized to use your account. You can view a list of connected applications and revoke access as needed.

### Security Keys and Passkey

A security key is a physical device that adds an extra layer of security to your online accounts. It is used in conjunction with a password or other authentication method to confirm your identity during the sign-in process.
In the **Security Keys and Passkey** section, you can register a physical security key or passkey to add an extra layer of protection to your account. This key works alongside your password to verify your identity during login.

### Device Verification

When logging in from a new device, we'll ask for email confirmation and send a verification code. Once you successfully log in, the device will be added to the list of trusted devices.

Click **Enable New Device Verification** to enable this feature.
Enable **Device Verification** to add an extra security step when logging in from a new device. Crowdin Enterprise will send a verification code to your registered email address to confirm your identity before allowing access from the new device. Once you successfully log in, the device will be added to the list of trusted devices.

<Aside>
You can disable this option only if you are using any 2FA, like Authenticator app or Security Keys
You can disable this option only if you are using any 2FA, like Authenticator app or Security Keys.
</Aside>

After enabling this feature, you will see a list of trusted devices. You can remove any device from the list by clicking the **Remove** button. Alternatively, you can remove all trusted devices by clicking **Remove All**.

### Auth Providers

In the **Auth Providers** section, you can connect your Facebook, Google, X, GitHub, or GitLab accounts to log into your Crowdin Enterprise account with one click.
In the **Auth providers** section, you can manage the accounts linked to your Crowdin Enterprise account. These connections allow you to log in with a single click using providers like Google, Facebook, GitHub, X, and GitLab.

### Security Log

Expand All @@ -128,49 +124,53 @@ Security log includes events like logins, password and username changes, and oth

### Sessions

In the **Sessions** section, you can review the list of devices (including the location, last activity date, IP address, browser, and operating system) logged into your Crowdin Enterprise account.

If there are any sessions you don't recognize, you can revoke them by clicking **Revoke** on the specific session. Alternatively, you can revoke all but the active session by clicking **Revoke All**.
In the **Sessions** section, you can view the list of devices that have accessed your Crowdin Enterprise account, including details like location, last activity date, IP address, and device type. Revoke individual sessions that you don't recognize, or revoke all except your current session by clicking **Revoke All**.

### Sudo Mode

Crowdin Enterprise asks you to confirm your password before you can perform any of the sudo-protected actions that include creating/changing your password and email, connecting/disconnecting SSO, enabling/disabling two-factor authentication, creating personal access tokens, and deleting your account.

After you've confirmed your password, you’ll be able to perform the sudo-protected actions without additional re-authentication within the next five minutes.
Crowdin Enterprise asks you to confirm your password before performing sensitive actions, such as changing your password, managing email or authentication settings, and deleting your account. Once confirmed, you can perform these actions without re-authenticating for the next five minutes.

<Image src={sudoModeConfirmingCredentials} alt="Confirming credentials" class="width-md" />

## Notifications

In the **Notifications** tab, you can enable notifications you’d like to receive and disable the ones that require less attention. You can select the types of events in Crowdin Enterprise, channels to receive updates, and set notification rules for particular projects.
In the **Notifications** tab, you can customize which notifications you receive and how they are delivered. This includes setting preferences for different notification channels and configuring rules for specific projects.

### Channels & Events

There are four channels Crowdin Enterprise can send notifications to:
Crowdin Enterprise provides several channels for notifications:

* In-App (Crowdin Enterprise)
* Email
* Slack
* Custom Notifications

Click the disclosure button next to the notification channel and select the notifications you'd like to receive.
Click the disclosure button next to a notification channel and customize it by selecting the events you want to be notified about.

The following notification events are available:
Available notification events include:

<Include file="notification-types-enterprise.mdx" />

### Slack Notifications

To use Slack for notifications, click **Slack** and authorize Crowdin Enterprise to integrate with Slack. After completing the setup, you can choose which notifications to receive in Slack.

<ReadMore>
Read more about [Custom Notifications](/enterprise/account-notifications/#custom-notifications).
Read more about [Slack Integration](/enterprise/account-notifications/#slack-integration).
</ReadMore>

### Slack Notifications
### Custom Notifications

To select Slack as a notification channel, click **Slack** and authorize the connection with Crowdin Enterprise on the Slack side. After the simple setup, you’ll be able to select notifications to get via Slack.
To use a custom channel for notifications, click **Set Up Notifications Custom Channel** and follow the setup instructions to configure it. After setup, you can select which notifications to send to your custom channel.

<ReadMore>
Read more about [Slack Integration](/enterprise/account-notifications/#slack-integration).
Read more about [Custom Notifications](/enterprise/account-notifications/#custom-notifications).
</ReadMore>

### Product Updates

Subscribe to the [Crowdin blog](https://crowdin.com/blog) to receive key product updates and localization best practices directly in your inbox. Stay informed about the latest features and improvements.

### Notification Rules for Projects

You can also configure notification preferences on the project level:
Expand All @@ -181,12 +181,12 @@ You can also configure notification preferences on the project level:

## Access Tokens

Personal access tokens are the alternative passwords you can use to authorize third-party applications and scripts into Crowdin Enterprise.
Personal access tokens serve as alternative passwords for authorizing third-party applications and scripts in Crowdin Enterprise.

<Image src={tokens} alt="Access Tokens" />

<Aside type="caution">
Treat personal access tokens like passwords and keep them secret. Use tokens as environmental variables instead of hardcoding them into your scripts.
Treat personal access tokens like passwords and keep them secure. Use tokens as environment variables instead of hardcoding them into your scripts.
</Aside>

### Use Cases
Expand All @@ -201,7 +201,7 @@ A personal access token is required for authorization in Crowdin Enterprise in t

### Creating a Personal Access Token

When creating a new personal access token, you can select [specific scopes](/developer/understanding-scopes/) and, if needed, limit the visibility of resources for the selected scopes using the **Granular access** option. For example, you can create a token that should interact only with a specific project or group and have no access to others. As a result, only the selected items will be gained when retrieving a list of all projects or groups.
When creating a new personal access token, you can select [specific scopes](/developer/understanding-scopes/) and, if needed, limit the visibility of resources for the selected scopes using the **Granular access** option. For example, you can create a token that should interact only with a specific project or group and have no access to others. As a result, only the selected items will be gained when retrieving a list of all projects or groups.

To create a new personal access token, follow these steps:

Expand All @@ -216,17 +216,19 @@ To create a new personal access token, follow these steps:
1. Click **Create**.
</Steps>

After generating a new token, be sure to record it right away. For security purposes, it will not be shown again. You can create as many personal access tokens as you need from your Crowdin Enterprise account.
After creating a new token, be sure to record it immediately. For security reasons, it will not be shown again. You can create as many personal access tokens as you need from your Crowdin Enterprise account.

<Aside type="caution">
If a resource wasn't selected during the personal access token creation, but you still try to access it with its ID, the `404 Not Found` response will be received.
If a resource wasn't selected during the personal access token creation, and you attempt to access it using its ID, you will receive a `404 Not Found` response.
</Aside>

### Revoking a Personal Access Token

You might need to revoke a personal access token if you no longer use it or suspect it has been compromised. To revoke a personal access token, follow these steps:
You may need to revoke a personal access token if you no longer use it or suspect it has been compromised.

To revoke a personal access token, follow these steps:

<Steps>
1. Open your **Account Settings** and go to the **Access tokens** tab.
1. Find the necessary token in the list and click **Revoke** next to it to delete a personal access token and remove its access.
1. Find the necessary token in the list and click **Revoke** next to it to delete the personal access token and remove its access.
</Steps>

0 comments on commit 8f43f8c

Please sign in to comment.