From 1eabafb9a5d24381e14d283a29315bbb50db4bbd Mon Sep 17 00:00:00 2001 From: Gabriel Goncalves Date: Mon, 18 Sep 2023 16:24:43 -0300 Subject: [PATCH 01/43] introduction to japanese --- docusaurus.config.js | 13 + i18n/ja/code.json | 62 +- .../current.json | 70 + .../current/best-practices/account-types.mdx | 31 + .../optimize-bucketeer-with-tags.mdx | 95 + .../current/bucketeer-docs.md | 118 + .../contribution-guide/contributing.md | 91 + .../documentation-style/01-consistency.md | 28 + .../documentation-style/02-voice-and-tone.md | 63 + .../03-formatting-and-organization.md | 223 + .../04-language-and-grammar.md | 62 + .../documentation-style/05-punctuation.md | 83 + .../06-ui-elements-and-interaction.md | 53 + .../documentation-style/07-links.md | 70 + .../documentation-style/08-code-elements.md | 78 + .../09-command-line-syntax.md | 54 + .../documentation-style/index.md | 75 + .../current/contribution-guide/index.md | 12 + .../current/feature-flags/api-keys.mdx | 35 + .../creating-feature-flags/auto-operation.mdx | 94 + .../create-feature-flag.md | 59 + .../evaluate-results.mdx | 25 + .../manage-variations.mdx | 31 + .../settings-and-history.md | 13 + .../creating-feature-flags/targeting.mdx | 159 + .../current/feature-flags/index.md | 28 + .../testing-with-flags/experiments.md | 46 + .../feature-flags/testing-with-flags/goals.md | 58 + .../feature-flags/testing-with-flags/index.md | 15 + .../testing-with-flags/using-experiments.md | 85 + .../getting-started/bucketeer-dashboard.mdx | 31 + .../getting-started/bucketeer-vocabulary.mdx | 13 + .../getting-started/create-an-account.md | 39 + .../current/getting-started/index.mdx | 160 + .../quickstart/create-an-api-key.mdx | 28 + .../quickstart/create-your-first-flag.mdx | 39 + .../getting-started/quickstart/index.mdx | 29 + .../quickstart/integrate-bucketeer.mdx | 306 + .../current/integration/index.mdx | 17 + .../current/integration/notifications.mdx | 123 + .../current/integration/pushes.mdx | 115 + .../current/sdk/client-side/android/index.md | 446 + .../current/sdk/client-side/flutter/index.md | 364 + .../current/sdk/client-side/ios/index.md | 522 + .../sdk/client-side/javascript/index.md | 368 + .../current/sdk/index.md | 89 + .../current/sdk/server-side/go/index.md | 11 + .../current/sdk/server-side/node-js/index.md | 11 + i18n/ja/docusaurus-theme-classic/navbar.json | 22 + package-lock.json | 2536 ++-- yarn.lock | 12488 ++++++++-------- 51 files changed, 12342 insertions(+), 7344 deletions(-) create mode 100644 i18n/ja/docusaurus-plugin-content-docs/current.json create mode 100644 i18n/ja/docusaurus-plugin-content-docs/current/best-practices/account-types.mdx create mode 100644 i18n/ja/docusaurus-plugin-content-docs/current/best-practices/optimize-bucketeer-with-tags.mdx create mode 100644 i18n/ja/docusaurus-plugin-content-docs/current/bucketeer-docs.md create mode 100644 i18n/ja/docusaurus-plugin-content-docs/current/contribution-guide/contributing.md create mode 100644 i18n/ja/docusaurus-plugin-content-docs/current/contribution-guide/documentation-style/01-consistency.md create mode 100644 i18n/ja/docusaurus-plugin-content-docs/current/contribution-guide/documentation-style/02-voice-and-tone.md create mode 100644 i18n/ja/docusaurus-plugin-content-docs/current/contribution-guide/documentation-style/03-formatting-and-organization.md create mode 100644 i18n/ja/docusaurus-plugin-content-docs/current/contribution-guide/documentation-style/04-language-and-grammar.md create mode 100644 i18n/ja/docusaurus-plugin-content-docs/current/contribution-guide/documentation-style/05-punctuation.md create mode 100644 i18n/ja/docusaurus-plugin-content-docs/current/contribution-guide/documentation-style/06-ui-elements-and-interaction.md create mode 100644 i18n/ja/docusaurus-plugin-content-docs/current/contribution-guide/documentation-style/07-links.md create mode 100644 i18n/ja/docusaurus-plugin-content-docs/current/contribution-guide/documentation-style/08-code-elements.md create mode 100644 i18n/ja/docusaurus-plugin-content-docs/current/contribution-guide/documentation-style/09-command-line-syntax.md create mode 100644 i18n/ja/docusaurus-plugin-content-docs/current/contribution-guide/documentation-style/index.md create mode 100644 i18n/ja/docusaurus-plugin-content-docs/current/contribution-guide/index.md create mode 100644 i18n/ja/docusaurus-plugin-content-docs/current/feature-flags/api-keys.mdx create mode 100644 i18n/ja/docusaurus-plugin-content-docs/current/feature-flags/creating-feature-flags/auto-operation.mdx create mode 100644 i18n/ja/docusaurus-plugin-content-docs/current/feature-flags/creating-feature-flags/create-feature-flag.md create mode 100644 i18n/ja/docusaurus-plugin-content-docs/current/feature-flags/creating-feature-flags/evaluate-results.mdx create mode 100644 i18n/ja/docusaurus-plugin-content-docs/current/feature-flags/creating-feature-flags/manage-variations.mdx create mode 100644 i18n/ja/docusaurus-plugin-content-docs/current/feature-flags/creating-feature-flags/settings-and-history.md create mode 100644 i18n/ja/docusaurus-plugin-content-docs/current/feature-flags/creating-feature-flags/targeting.mdx create mode 100644 i18n/ja/docusaurus-plugin-content-docs/current/feature-flags/index.md create mode 100644 i18n/ja/docusaurus-plugin-content-docs/current/feature-flags/testing-with-flags/experiments.md create mode 100644 i18n/ja/docusaurus-plugin-content-docs/current/feature-flags/testing-with-flags/goals.md create mode 100644 i18n/ja/docusaurus-plugin-content-docs/current/feature-flags/testing-with-flags/index.md create mode 100644 i18n/ja/docusaurus-plugin-content-docs/current/feature-flags/testing-with-flags/using-experiments.md create mode 100644 i18n/ja/docusaurus-plugin-content-docs/current/getting-started/bucketeer-dashboard.mdx create mode 100644 i18n/ja/docusaurus-plugin-content-docs/current/getting-started/bucketeer-vocabulary.mdx create mode 100644 i18n/ja/docusaurus-plugin-content-docs/current/getting-started/create-an-account.md create mode 100644 i18n/ja/docusaurus-plugin-content-docs/current/getting-started/index.mdx create mode 100644 i18n/ja/docusaurus-plugin-content-docs/current/getting-started/quickstart/create-an-api-key.mdx create mode 100644 i18n/ja/docusaurus-plugin-content-docs/current/getting-started/quickstart/create-your-first-flag.mdx create mode 100644 i18n/ja/docusaurus-plugin-content-docs/current/getting-started/quickstart/index.mdx create mode 100644 i18n/ja/docusaurus-plugin-content-docs/current/getting-started/quickstart/integrate-bucketeer.mdx create mode 100644 i18n/ja/docusaurus-plugin-content-docs/current/integration/index.mdx create mode 100644 i18n/ja/docusaurus-plugin-content-docs/current/integration/notifications.mdx create mode 100644 i18n/ja/docusaurus-plugin-content-docs/current/integration/pushes.mdx create mode 100644 i18n/ja/docusaurus-plugin-content-docs/current/sdk/client-side/android/index.md create mode 100644 i18n/ja/docusaurus-plugin-content-docs/current/sdk/client-side/flutter/index.md create mode 100644 i18n/ja/docusaurus-plugin-content-docs/current/sdk/client-side/ios/index.md create mode 100644 i18n/ja/docusaurus-plugin-content-docs/current/sdk/client-side/javascript/index.md create mode 100644 i18n/ja/docusaurus-plugin-content-docs/current/sdk/index.md create mode 100644 i18n/ja/docusaurus-plugin-content-docs/current/sdk/server-side/go/index.md create mode 100644 i18n/ja/docusaurus-plugin-content-docs/current/sdk/server-side/node-js/index.md create mode 100644 i18n/ja/docusaurus-theme-classic/navbar.json diff --git a/docusaurus.config.js b/docusaurus.config.js index dc506091..9c5dfa5a 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -33,6 +33,14 @@ const config = { i18n: { defaultLocale: 'en', locales: [ 'en', 'ja' ], + localeConfigs: { + en: { + label: 'English', + }, + ja: { + label: 'Japanese', + }, + }, }, presets: [ @@ -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: { diff --git a/i18n/ja/code.json b/i18n/ja/code.json index b64b56c0..eb15b07d 100644 --- a/i18n/ja/code.json +++ b/i18n/ja/code.json @@ -5,7 +5,7 @@ }, "theme.ErrorPageContent.tryAgain": { "message": "Try again", - "description": "The label of the button to try again when the page crashed" + "description": "The label of the button to try again rendering when the React error boundary captures an error" }, "theme.NotFound.title": { "message": "ページが見つかりません", @@ -229,5 +229,65 @@ "theme.docs.sidebar.expandButtonAriaLabel": { "message": "サイドバーを開く", "description": "The ARIA label and title attribute for expand button of doc sidebar" + }, + "theme.admonition.note": { + "message": "注記", + "description": "The default label used for the Note admonition (:::note)" + }, + "theme.admonition.tip": { + "message": "ヒント", + "description": "The default label used for the Tip admonition (:::tip)" + }, + "theme.admonition.danger": { + "message": "危険", + "description": "The default label used for the Danger admonition (:::danger)" + }, + "theme.admonition.info": { + "message": "備考", + "description": "The default label used for the Info admonition (:::info)" + }, + "theme.admonition.caution": { + "message": "注意", + "description": "The default label used for the Caution admonition (:::caution)" + }, + "theme.NavBar.navAriaLabel": { + "message": "Main", + "description": "The ARIA label for the main navigation" + }, + "theme.docs.sidebar.navAriaLabel": { + "message": "Docs sidebar", + "description": "The ARIA label for the sidebar navigation" + }, + "theme.docs.sidebar.closeSidebarButtonAriaLabel": { + "message": "Close navigation bar", + "description": "The ARIA label for close button of mobile sidebar" + }, + "theme.docs.sidebar.toggleSidebarButtonAriaLabel": { + "message": "Toggle navigation bar", + "description": "The ARIA label for hamburger menu button of mobile navigation" + }, + "cmfcmf/d-s-l.searchBar.placeholder": { + "message": "検索...", + "description": "Placeholder shown in the searchbar" + }, + "cmfcmf/d-s-l.searchBar.clearButtonTitle": { + "message": "Clear", + "description": "Title of the button to clear the current search input" + }, + "cmfcmf/d-s-l.searchBar.detachedCancelButtonText": { + "message": "Cancel", + "description": "Text of the button to close the detached search window" + }, + "cmfcmf/d-s-l.searchBar.submitButtonTitle": { + "message": "Submit", + "description": "Title of the button to submit a new search" + }, + "cmfcmf/d-s-l.searchBar.noResults": { + "message": "該当する結果はありません。", + "description": "message shown if no results are found" + }, + "theme.tags.tagsPageTitle": { + "message": "タグ", + "description": "The title of the tag list page" } } diff --git a/i18n/ja/docusaurus-plugin-content-docs/current.json b/i18n/ja/docusaurus-plugin-content-docs/current.json new file mode 100644 index 00000000..5056a49a --- /dev/null +++ b/i18n/ja/docusaurus-plugin-content-docs/current.json @@ -0,0 +1,70 @@ +{ + "version.label": { + "message": "Next", + "description": "The label for version current" + }, + "sidebar.docs.category.Quickstart": { + "message": "Quickstart", + "description": "The label for category Quickstart in sidebar docs" + }, + "sidebar.docs.category.Creating Feature Flags": { + "message": "Creating Feature Flags", + "description": "The label for category Creating Feature Flags in sidebar docs" + }, + "sidebar.docs.category.Testing With Flags": { + "message": "Testing With Flags", + "description": "The label for category Testing With Flags in sidebar docs" + }, + "sidebar.docs.category.Client": { + "message": "Client", + "description": "The label for category Client in sidebar docs" + }, + "sidebar.docs.category.Server": { + "message": "Server", + "description": "The label for category Server in sidebar docs" + }, + "sidebar.docs.category.Documentation Style": { + "message": "Documentation Style", + "description": "The label for category Documentation Style in sidebar docs" + }, + "sidebar.docs.doc.Bucketeer Docs": { + "message": "Bucketeer ドキュメント", + "description": "The label for the doc item Bucketeer Docs in sidebar docs, linking to the doc bucketeer-docs" + }, + "sidebar.docs.doc.Introduction": { + "message": "Introduction", + "description": "The label for the doc item Introduction in sidebar docs, linking to the doc getting-started/introduction" + }, + "sidebar.docs.doc.Create an account": { + "message": "Create an account", + "description": "The label for the doc item Create an account in sidebar docs, linking to the doc getting-started/create-an-account" + }, + "sidebar.docs.doc.Bucketeer Vocabulary": { + "message": "Bucketeer Vocabulary", + "description": "The label for the doc item Bucketeer Vocabulary in sidebar docs, linking to the doc getting-started/bucketeer-vocabulary" + }, + "sidebar.docs.doc.Overview": { + "message": "Overview", + "description": "The label for the doc item Overview in sidebar docs, linking to the doc integration/index" + }, + "sidebar.docs.doc.API Keys": { + "message": "API Keys", + "description": "The label for the doc item API Keys in sidebar docs, linking to the doc feature-flags/api-keys" + }, + "sidebar.docs.doc.Pushes": { + "message": "Pushes", + "description": "The label for the doc item Pushes in sidebar docs, linking to the doc integration/pushes" + }, + "sidebar.docs.doc.Notifications": { + "message": "Notifications", + "description": "The label for the doc item Notifications in sidebar docs, linking to the doc integration/notifications" + }, + "sidebar.docs.doc.Optimize with tags": { + "message": "Optimize with tags", + "description": "The label for the doc item Optimize with tags in sidebar docs, linking to the doc best-practices/optimize-bucketeer-with-tags" + }, + "sidebar.docs.doc.Contributing": { + "message": "Contributing", + "description": "The label for the doc item Contributing in sidebar docs, linking to the doc contribution-guide/contributing" + } +} diff --git a/i18n/ja/docusaurus-plugin-content-docs/current/best-practices/account-types.mdx b/i18n/ja/docusaurus-plugin-content-docs/current/best-practices/account-types.mdx new file mode 100644 index 00000000..d6b3e923 --- /dev/null +++ b/i18n/ja/docusaurus-plugin-content-docs/current/best-practices/account-types.mdx @@ -0,0 +1,31 @@ +--- +title: Bucketeer account types +# sidebar_position: +slug: /best-practice/account-types +description: This page describes the existing account types available on Bucketter. +tags: ['guide', 'account', 'account-types'] +--- + +import CenteredImg from '@site/src/components/centered-img/CenteredImg'; + +There are two types of accounts available in Buckteers, each with different access levels: + +- **Admin account**: it provides full access and control over all existing projects. Members with admin accounts can access all existing environments and manage other member' accounts. + +- **Environment account**: it is associated with a specific environment on the platform. Members with Environment accounts can access all the features of that particular environment. + +:::note + +As an open-source project, you can host your Buckteers system version. In this case, you will create your own Admin account. + +If you are using the system hosted by Bucketeer, to create an Admin account you need to contact the Bucketeer team. + +::: + +## Environment account roles + +In addition to being limited to a specific environment, Environment accounts also have predefined roles assigned during the account creation process. The defined role will change the account access level. The available roles for Environment accounts are described below: + +- **Viewer**: viewers have read-only access to their assigned environments. They can view all data but can't make any modifications. This role is suitable for members of your organization who need visibility into feature flags without the ability to modify them. +- **Editor**: editors can modify feature flags, goals, experiments, and more within their assigned environments. However, they cannot add new team members or create API keys. +- **Owner**: owners can do anything within their assigned environments. Including adding team members, and API keys. diff --git a/i18n/ja/docusaurus-plugin-content-docs/current/best-practices/optimize-bucketeer-with-tags.mdx b/i18n/ja/docusaurus-plugin-content-docs/current/best-practices/optimize-bucketeer-with-tags.mdx new file mode 100644 index 00000000..a3bcc30f --- /dev/null +++ b/i18n/ja/docusaurus-plugin-content-docs/current/best-practices/optimize-bucketeer-with-tags.mdx @@ -0,0 +1,95 @@ +--- +title: Optimize Bucketeer with tags +# sidebar_position: +slug: /best-practices/optimize-with-tags +description: Describe the impact of using tags with feature flags and the best practices to define them. +tags: ['best-practices', 'tags'] +--- + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +The integration and utilization of Bucketeer are straightforward, giving you complete control over configuration and usage. However, one step can significantly impact server response time and costs, ultimately affecting the user experience. In this regard, we provide a brief overview of this topic, which's covered in more detail in the [Using Feature Flags](#) section. + +During step 3 of the [integration process](/getting-started/quickstart/integrate-bucketeer) you are required to provide the `featureTag`. To make your undertand easier, the code is replicated below: + + + + +```kotlin showLineNumbers +// Configure the SDK +val config = BKTConfig.builder() + .apiKey("YOUR_API_KEY") + .apiEndpoint("YOUR_API_ENDPOINT") + .featureTag("YOUR_FEATURE_TAG") + .build() +``` + + + + +```dart showLineNumbers +// Configure the SDK +final config = BKTConfigBuilder() + .apiKey("YOUR_API_KEY") + .apiURL("YOUR_API_URL") + .featureTag("YOUR_FEATURE_TAG") + .build(); +``` + + + + +```swift showLineNumbers +// Configure the SDK +let config = BKTConfig( + apiKey: "YOUR_API_KEY", + apiURL: "YOUR_API_URL", + featureTag: "YOUR_FEATURE_TAG" +) +``` + + + + +```js showLineNumbers +// Configure the SDK +const config = defineBKTConfig({ + apiKey: 'YOUR_API_KEY', + apiEndpoint: 'YOUR_API_URL', + featureTag: 'YOUR_FEATURE_TAG', + appVersion: 'YOUR_APP_VERSION', +}); +``` + + + + +```sh showLineNumbers +not available +``` + + + + +```sh showLineNumbers +not available +``` + + + + +The `featureTag` is defined when creating the feature flag and serves two purposes. Firstly, it assists in searching within the tag list on the Bucketeer dashboard. Secondly, and more crucially, the `featureTag` plays a critical role in optimizing the usage of the Bucketeer system. + +Feature tags act as limiters when making server calls to evaluate users. Consequently, if a call does not use tags or employs a tag used by numerous flags, a large number of feature flags will be returned for evaluation. This might not pose a problem for small systems with few flags. However, as the system expands, failure to utilize tags for identifying and optimizing evaluation calls can result in excessive processing on your server and increased operational costs. Moreover, it can lead to larger response times, negatively impacting the user experience. Therefore, employing targeted and assertive tags will: + +- Accelerate the evaluation process by analyzing only the necessary aspects. +- Reduce information traffic between the server and the local application. + +Despite the significance and impact on performance and costs, using tags within Bucketeer is optional. + +:::tip + +The Bucketeer team strongly recommends the use of `featureTag` to optimize your operation. + +::: diff --git a/i18n/ja/docusaurus-plugin-content-docs/current/bucketeer-docs.md b/i18n/ja/docusaurus-plugin-content-docs/current/bucketeer-docs.md new file mode 100644 index 00000000..046990b3 --- /dev/null +++ b/i18n/ja/docusaurus-plugin-content-docs/current/bucketeer-docs.md @@ -0,0 +1,118 @@ +--- +title: Bucketeer Docs +sidebar_position: 1 +slug: / +description: Describes what the Bucketeer is and its solution. In addition, the page also provides an overview of the main sections covered in the documentation. +tags: ['home', 'guide', 'presentation', 'overview', 'contact'] +--- + +import Button from '@site/src/components/button/Button'; +import ButtonShelf from '@site/src/components/button-shelf/ButtonShelf'; + +# Bucketeerドキュメントへようこそ + +Bucketeerドキュメントへようこそ。ここは、Bucketeerプラットフォーム、インテグレーション、SDKに関するあらゆる情報を得ることができるサイトです。Bucketeerソリューションを効果的に活用するために必要なすべての情報がここにあります。以下の便利なナビゲーションボタンを使用することで、目的のセクションにすばやくアクセスすることができます。さらにこのページでは、Bucketeerの主な特徴や機能を詳しくご紹介します。 + + +