Skip to content
Draft
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
17 changes: 9 additions & 8 deletions docs/getting-started/bucketeer-dashboard.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -18,14 +18,15 @@ The image below presents the Bucketeer dashboard sidebar, and after you find a d
alt="Bucketeer dashboard sidebar"
/>

- **(Project) Environment Selector**: use this selector to choose the desired project and environment. The modifications you make will only affect the current project/environment. Environments can be used to target specific parts of the project and make it easier to manage.
- **Environment Selector**: use this selector to choose the desired environment. The modifications you make will only affect the current environment. Environments can be used to target specific parts of the project and make it easier to manage.
- **Feature Flags**: this section displays all the flags within the selected project. You can choose a flag to manage its environment-specific targeting and rollout rules.
- **User Segments**: this page allows you to check all segments for the current environment. Select a segment to manage its settings.
- **Debugger**: verify which variation of a feature flag is assigned to a specific end-user. Use it for troubleshooting targeting rules and ensuring your flag logic works as intended.
- **Audit Logs**: access all the audit logs for the selected environment.
- **Goals**: manage all the goals associated with your project. Select a goal to adjust its settings.
- **Experiments**: view a list of experiments in the current environment. Select an experiment to manage its settings and view the results.
- **Segments**: this page allows you to check all segments for the current environment. Select a segment to manage its settings.
- **Audit Logs**: access all the audit logs for the selected environment.
- **Accounts**: manage user accounts for the current environment. You can add or remove users and change their roles.
- **API Keys**: check all the API Keys associated with the current environment. You can manage the settings of existing keys or add new ones.
- **Documentation**: use this link to access the Bucketeer documentation quickly.
- **Settings**: check and configure all the settings for the current environment. You can create notifications, pushes, and webhooks. Pushes enable real-time SDK updates. Notifications can alert you when someone adds or updates something in the admin console, and you can also monitor operational task statuses. The webhook feature allows you to control the on/off status of feature flags.
- **Admin Settings**: this section allows you to define several admin settings. You can create and manage projects and environments, create accounts, and review notifications and audit logs.
- **Gear icon**: this section allows you to manage several admin settings for your organization, including:
- Organization and project settings.
- Members and API keys.
- Available integrations, such as Slack and FCM.

21 changes: 17 additions & 4 deletions docs/getting-started/create-an-account.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,9 @@ Bucketeer allows you to manage and track data related to different environments.

The following steps show how to create an account as an Admin.

1. Select the target environment from the select menu on the top left.
2. Navigate to the **Accounts** page from the sidebar menu.
3. Click **+ Add** button to add a new account.
1. Click on the gear icon on the sidebar menu.
2. Select **Members**.
3. Click **+ Invite Member** button to add a new account.

<CenteredImg
imgURL='img/getting-started/create-bucketeer-account-1.png'
Expand All @@ -22,7 +22,20 @@ The following steps show how to create an account as an Admin.
/>

4. Enter the new member's email and define their role.
5. Click **Submit** to create the account.

:::info Teams
You can create teams and assign members to it.

Use teams to group members, making it easier when listing them on the list page.
::::

:::info Role Member

When you assign the role Member to a new account, the owner can only access information related to the Environment you choose. These users are unable to create or update organization settings, projects, environments, API keys, or members.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
When you assign the role Member to a new account, the owner can only access information related to the Environment you choose. These users are unable to create or update organization settings, projects, environments, API keys, or members.
When you assign the role Member to a new account, the user can only access the Environment you choose. These users are unable to create or update organization settings, projects, environments, API keys, or members.

::::


5. Click **Invite Member** to create the account.

<CenteredImg
imgURL='img/getting-started/create-bucketeer-account-2.png'
Expand Down
20 changes: 19 additions & 1 deletion docs/getting-started/quickstart/create-an-api-key.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,25 @@ To use feature flags, start by creating an API key on the Bucketeer dashboard. T

They identify your project and environment, ensuring your application retrieves the correct flag configurations. Additionally, they improve security by preventing unauthorized access and maintaining the integrity of your feature flag system.

To create an API key, access the **API Keys** from the sidebar. You will find all existing API keys on this page. To add a new API key, click **+ Add**. On the side panel, provide a name for the new API key and click **Submit**. The API key name has a length limit of a hundred characters.
To create an API key, click on the **gear icon** from the sidebar menu and select **API Keys**. You will find all existing API keys on this page. To add a new API key, click **+ New API Key**. On the side panel, provide:
Here are the descriptions for the missing items, following the same style as your document:
- **Name**: provide a meaningful name for your API key. This will help you identify it later in the list of keys.
- **Description** (optional): add a brief description to provide additional context about the key's purpose.
- **Environment**: select the environment where the API key will be used. This ensures the key is tied to the correct project and configurations.
- **Key Role**: choose between one of the available options. This selection determines the level of access and permissions for the API key.


:::info API Key Roles

| API Key Role | Description |
| :--- | :--- |
| **Client SDKs** | Allows all SDKs to evaluate end users using the Bucketeer server. |
| **Server SDKs** | Allows the server SDK to evaluate end users locally. For server-side evaluation using the Bucketeer server, use a Client SDK key. |
| **Public API (Read Only)** | Allows read-only access to data in Bucketeer. |
| **Public API (Read and Write)** | Allows reading and writing data in Bucketeer. |
| **Public API (Admin)** | Allows full read and write access to all data in Bucketeer, including environment settings. |

:::

:::tip

Expand Down
2 changes: 1 addition & 1 deletion docs/getting-started/quickstart/integrate-bucketeer.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -335,7 +335,7 @@ if (showNewFeature) {
</TabItem>
</Tabs>

5. **Check events**: Each flag has an Evaluation page where you can track its usage. To check usage data, access the dashboard, go to **Feature Flags**, select the desired flag, and switch to the **Evaluation** tab. If recorded data exists on this page, your implementation was successful. Otherwise, revisit the previous steps and make sure you executed tests using the created flag. The image below presents an example of a correct integration.
5. **Check events**: Each flag has an Evaluation page where you can track its usage. To check usage data, access the dashboard, go to **Feature Flags**, select the desired flag, and switch to the **Evaluations** tab. If recorded data exists on this page, your implementation was successful. Otherwise, revisit the previous steps and make sure you executed tests using the created flag. The image below presents an example of a correct integration.

<CenteredImg
imgURL="img/getting-started/quickstart/evaluation-panel-24h.png"
Expand Down
Binary file modified static/img/getting-started/create-bucketeer-account-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified static/img/getting-started/create-bucketeer-account-2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified static/img/getting-started/dashboard-sidebar.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified static/img/getting-started/quickstart/create-api-key.png
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 modified static/img/getting-started/quickstart/created-feature-flag.png
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