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

docs: japanese translation v2 #35

Open
wants to merge 37 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
37 commits
Select commit Hold shift + click to select a range
1eabafb
introduction to japanese
gabrielraeder Sep 18, 2023
af263b7
introduction
gabrielraeder Sep 18, 2023
ac574ae
getting-started index
gabrielraeder Sep 18, 2023
795c9da
dashboard
gabrielraeder Sep 18, 2023
9c2a5aa
vocabulary
gabrielraeder Sep 18, 2023
44f3637
quickstart create-api-key
gabrielraeder Sep 18, 2023
d3a56db
create-your-first-flag
gabrielraeder Sep 18, 2023
d0e708c
integrate-bucketeer
gabrielraeder Sep 18, 2023
fb97620
feature-flags overview
gabrielraeder Sep 19, 2023
1ac9d0c
apikeys and create-feature-flag
gabrielraeder Sep 19, 2023
dccbff9
targeting
gabrielraeder Sep 19, 2023
5030ff0
manage-variations
gabrielraeder Sep 19, 2023
a437cd7
auto-operations
gabrielraeder Sep 19, 2023
5804ebc
evaluate-results
gabrielraeder Sep 19, 2023
453a155
settings-history
gabrielraeder Sep 19, 2023
a62b586
testing-with-flags
gabrielraeder Sep 19, 2023
d94d226
experiments
gabrielraeder Sep 19, 2023
6b7a823
using-experiments
gabrielraeder Sep 19, 2023
c8b1e77
goals
gabrielraeder Sep 19, 2023
70f3f4b
sdk overview
gabrielraeder Sep 19, 2023
5ffe3bf
client android
gabrielraeder Sep 19, 2023
109945c
client ios
gabrielraeder Sep 19, 2023
f96e26e
client flutter
gabrielraeder Sep 19, 2023
85319cf
client js
gabrielraeder Sep 19, 2023
7476a48
integration overview
gabrielraeder Sep 19, 2023
9d2caff
notifications
gabrielraeder Sep 19, 2023
067c2be
pushes
gabrielraeder Sep 19, 2023
4b21c2f
optimize-with-tags
gabrielraeder Sep 19, 2023
dfd0161
account-types
gabrielraeder Sep 19, 2023
73806c4
contributing
gabrielraeder Sep 19, 2023
71ed3c5
see more and updateUserAttributes resolved
gabrielraeder Sep 19, 2023
9cbfeeb
docs: create configuration category
htessaro Sep 20, 2023
f65f824
Merge branch 'japanese' of github.com:writechoiceorg/bucketeer-docs-j…
htessaro Sep 20, 2023
4c705cf
configuration section
gabrielraeder Sep 20, 2023
369cf55
fixed links to configuration section
gabrielraeder Sep 20, 2023
c3c279b
links completed
gabrielraeder Sep 20, 2023
830cfa4
crowdin configs
gabrielraeder Oct 11, 2023
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
10 changes: 10 additions & 0 deletions crowdin.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
project_id: '619760'
api_token: 71920d310ddf281a4d742dbeae5fba47c3f3c577bbd243c98f2dbfd917dd166e11aa6bcf4235b4e8
preserve_hierarchy: true
files:
# JSON translation files
- source: /i18n/en/**/*
translation: /i18n/%two_letters_code%/**/%original_file_name%
# Docs Markdown files
- source: /docs/**/*
translation: /i18n/%two_letters_code%/docusaurus-plugin-content-docs/current/**/%original_file_name%
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Bucketeer account types
# sidebar_position:
slug: /best-practice/account-types
slug: /configuration/account-types
description: This page describes the existing account types available on Bucketter.
tags: ['guide', 'account', 'account-types']
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: API keys
# sidebar_position:
slug: /feature-flags/api-keys
slug: /configuration/api-keys
description: Describes what API keys are, what they are used for, and how to create them.
tags: ['integration', 'feature-flag']
---
Expand Down
17 changes: 17 additions & 0 deletions docs/configuration/configuration.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
id: configuration
title: Configuration
slug: /configuration
---

# Configurations

In this category, you will find information regarding complementary settings you can do when using the Bucketeer dashboard. The configurations available on these pages support the feature flag creation and usage. Below, you find the links and a brief description for each section.

## API keys

The [API keys](/configuration/api-keys) describe what they're and how they're used to authenticate and control access to the Bucketeer system.

## Account types

The [Account types](/configuration/account-types) present the different account types available on Bucketeer. You can use these different account types to provide different access levels to each team member.
4 changes: 0 additions & 4 deletions docs/feature-flags/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,6 @@ This section presents the necessary information to use Bucketeer feature flags.
- [Evaluate results](../feature-flags/creating-feature-flags/evaluate-results): Explore how to evaluate and analyze the usage of your flags.
- [Other flag settings](../feature-flags/creating-feature-flags/settings-and-history): Explore additional settings and options for your flags.

## API keys

The [API keys](/feature-flags/api-keys) describe what they're and how they're used to authenticate and control access to the Bucketeer system.

## Testing with flags

The [Testing with flags](../feature-flags/testing-with-flags) will cover the three components used to perform tests on the Bucketeer system:
Expand Down
2 changes: 1 addition & 1 deletion docs/getting-started/create-an-account.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ tags: ['guide', 'account', 'create']

import CenteredImg from '@site/src/components/centered-img/CenteredImg';

Bucketeer allows you to manage and track data related to different environments. To begin using Bucketeer, you need an account. For additional information regarding the available account types on Bucketeer, check the [Bucketeer account types](../best-practice/account-types). Ask the project administrator to create an account if you're a new team member.
Bucketeer allows you to manage and track data related to different environments. To begin using Bucketeer, you need an account. For additional information regarding the available account types on Bucketeer, check the [Bucketeer account types](../configuration/account-types). Ask the project administrator to create an account if you're a new team member.

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

Expand Down
16 changes: 7 additions & 9 deletions docs/getting-started/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ Flags also enable A/B testing, allowing developers to compare different feature

Additionally, feature flags align with trunk-based development, enabling developers to merge changes to a shared codebase without affecting production users. This practice ensures a releasable codebase, fostering collaboration within large teams.

To learn how to use and take advantage of flags on Bucketeer, check the [Using Feature Flags](#) section.
To learn how to use and take advantage of flags on Bucketeer, check the [Using Feature Flags](/feature-flags) section.

## Member roles on Bucketeer

Expand All @@ -68,7 +68,7 @@ Bucketeer was designed to accommodate different types of members. Below you find
<p>
To get started, you will need to set up feature flags on the Bucketeer
dashboard. You can refer to the
<a href="#"> Using Feature Flags</a> guide to learn more
<a href="/feature-flags"> Using Feature Flags</a> guide to learn more
about the process. Once you have your credentials and have created a feature
flag, you can choose an SDK that best suits your application. The <a href="/sdk">
SDK
Expand Down Expand Up @@ -97,7 +97,7 @@ Bucketeer was designed to accommodate different types of members. Below you find
First and foremost, it's important to understand how to enable or disable
feature flags. Familiarize yourself with managing flags and the mechanisms
for toggling them on and off with the
<a href="#"> Using Feature Flags</a> guide.
<a href="/feature-flags"> Using Feature Flags</a> guide.
</p>
<p>
In addition to managing flags, you play a crucial role in designing and
Expand All @@ -111,7 +111,7 @@ Bucketeer was designed to accommodate different types of members. Below you find
Utilizing feature flags enables you to conduct various types of testing,
such as A/B testing. For more detailed information on experimentation,
please refer to the
<a href="#/testing-with0flags"> Testing with flags </a>
<a href="/feature-flags#testing-with-flags"> Testing with flags </a>
resource.
</p>
<p>
Expand Down Expand Up @@ -150,11 +150,9 @@ Bucketeer was designed to accommodate different types of members. Below you find
platform. This includes tasks such as adding or removing members, assigning
appropriate roles and permissions, and ensuring that the right level of
access is granted to individuals based on their responsibilities. Check{' '}
<a href="/getting-started/create-an-account">
Create Bucketeer's account
</a>{' '}
<a href="/getting-started/create-an-account">Create Bucketeer's account</a>{' '}
to learn more about account creation or access the{' '}
<a href="#">Bucketeer account types</a> to
learn more about the existing roles.
<a href="/configuration/account-types">Bucketeer account types</a> to learn
more about the existing roles.
</p>
</details>
2 changes: 1 addition & 1 deletion docs/getting-started/quickstart/create-an-api-key.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -25,4 +25,4 @@ The Bucketeer team recommends naming the API key based on the system where it wi
wSize="100%"
/>

After creating the API key, it will appear on the **API Keys** page, and its state will be **ON**, meaning it's ready for use. Now you can move on to the next step and [create your first feature flag](/getting-started/quickstart/create-your-first-flag). However, if you want to learn more about the usage of the API keys, check the [API keys](#) page.
After creating the API key, it will appear on the **API Keys** page, and its state will be **ON**, meaning it's ready for use. Now you can move on to the next step and [create your first feature flag](/getting-started/quickstart/create-your-first-flag). However, if you want to learn more about the usage of the API keys, check the [API keys](/configuration/api-keys) page.
6 changes: 3 additions & 3 deletions docs/sdk/client-side/android/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -325,7 +325,7 @@ In regular use, you don't need to call the flush method because the events are s

### User attributes configuration

This feature will give you robust and granular control over what users can see on your application. You can add rules using these attributes on the console UI's feature flag's targeting tab. [See more](#).
This feature will give you robust and granular control over what users can see on your application. You can add rules using these attributes on the console UI's feature flag's targeting tab. [See more](/feature-flags/creating-feature-flags/targeting#user-attributes).

<Tabs>
<TabItem value="kt" label="Kotlin">
Expand Down Expand Up @@ -382,7 +382,7 @@ This updating method will override the current data.

### Getting user information

This method will return the current user configured in the SDK. This is useful when you want to check the current user id and attributes before updating them through [updateUserAttributes](#updating-user-attributes).
This method will return the current user configured in the SDK. This is useful when you want to check the current user id and attributes before updating them through [updateUserAttributes](android#updating-user-attributes).

<Tabs>
<TabItem value="kt" label="Kotlin">
Expand All @@ -408,7 +408,7 @@ val evaluationDetails = client.evaluationDetails("YOUR_FEATURE_FLAG_ID")

:::caution

Do not call this method without calling the [Evaluating user method](#evaluating-user). The Evaluating user method must always be called because it generates analytics events that will be sent to the server.
Do not call this method without calling the [Evaluating user method](android#evaluating-user). The Evaluating user method must always be called because it generates analytics events that will be sent to the server.

:::

Expand Down
4 changes: 2 additions & 2 deletions docs/sdk/client-side/flutter/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -275,7 +275,7 @@ In regular use, you don't need to call the flush method because the events are s

### User attributes configuration

This feature will give you robust and granular control over what users can see on your application. You can add rules using these attributes on the console UI's feature flag's targeting tab. [See more](#).
This feature will give you robust and granular control over what users can see on your application. You can add rules using these attributes on the console UI's feature flag's targeting tab. [See more](/feature-flags/creating-feature-flags/targeting#user-attributes).

<Tabs>
<TabItem value="dart" label="Dart">
Expand Down Expand Up @@ -331,7 +331,7 @@ This updating method will override the current data.

### Getting user information

This method will return the current user configured in the SDK. This is useful when you want to check the current user id and attributes before updating them through [updateUserAttributes](#getting-user-information).
This method will return the current user configured in the SDK. This is useful when you want to check the current user id and attributes before updating them through [updateUserAttributes](flutter#updating-user-attributes).

<Tabs>
<TabItem value="dart" label="Dart">
Expand Down
6 changes: 3 additions & 3 deletions docs/sdk/client-side/ios/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -389,7 +389,7 @@ In regular use, you don't need to call the flush method because the events are s

### User attributes configuration

This feature will give you robust and granular control over what users can see on your application. You can add rules using these attributes on the console UI's feature flag's targeting tab. [See more](#).
This feature will give you robust and granular control over what users can see on your application. You can add rules using these attributes on the console UI's feature flag's targeting tab. [See more](/feature-flags/creating-feature-flags/targeting#user-attributes).

<Tabs>
<TabItem value="swift" label="Swift">
Expand Down Expand Up @@ -454,7 +454,7 @@ This updating method will override the current data.

### Getting user information

This method will return the current user configured in the SDK. This is useful when you want to check the current user id and attributes before updating them through [updateUserAttributes](#getting-user-information).
This method will return the current user configured in the SDK. This is useful when you want to check the current user id and attributes before updating them through [updateUserAttributes](ios#updating-user-attributes).

<Tabs>
<TabItem value="swift" label="Swift">
Expand All @@ -480,7 +480,7 @@ let evaluationDetails = client.evaluationDetails(featureId: "YOUR_FEATURE_FLAG_I

:::caution

Do not call this method without calling the [Evaluating user method](#evaluating-user). The Evaluating user method must always be called because it generates analytics events that will be sent to the server.
Do not call this method without calling the [Evaluating user method](ios#evaluating-user). The Evaluating user method must always be called because it generates analytics events that will be sent to the server.

:::

Expand Down
4 changes: 2 additions & 2 deletions docs/sdk/client-side/javascript/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -251,7 +251,7 @@ In regular use, you don't need to call the flush method because the events are s

### User attributes configuration

This feature will give you robust and granular control over what users can see on your application. You can add rules using these attributes on the console UI's feature flag's targeting tab. [See more](#).
This feature will give you robust and granular control over what users can see on your application. You can add rules using these attributes on the console UI's feature flag's targeting tab. [See more](/feature-flags/creating-feature-flags/targeting#user-attributes).

<Tabs>
<TabItem value="js" label="JavaScript">
Expand Down Expand Up @@ -306,7 +306,7 @@ This updating method will override the current data.

### Getting user information

This method will return the current user configured in the SDK. This is useful when you want to check the current user id and attributes before updating them through [updateUserAttributes](#getting-user-information).
This method will return the current user configured in the SDK. This is useful when you want to check the current user id and attributes before updating them through [updateUserAttributes](javascript#updating-user-attributes).

<Tabs>
<TabItem value="js" label="JavaScript">
Expand Down
13 changes: 13 additions & 0 deletions docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,14 @@ const config = {
i18n: {
defaultLocale: 'en',
locales: [ 'en', 'ja' ],
localeConfigs: {
en: {
label: 'English',
},
ja: {
label: 'Japanese',
},
},
},

presets: [
Expand Down Expand Up @@ -135,6 +143,11 @@ const config = {
className: 'header-slack-link',
'aria-label': 'Bucketeer Slack - Join the conversation',
},
{
type: 'localeDropdown',
position: 'right',
className: 'language_dropdown'
},
],
},
prism: {
Expand Down
Loading
Loading