機能フラグ
機能フラグプロバイダーを通じて訪問者データをドキュメントに渡す
機能フラグと一緒に適応コンテンツを使用するには、アプリケーションにコードを追加する必要があります。
現在、GitBook ヘルパーは React ベースのセットアップのみをサポートしています。
GitBook は、以下のような一般的な機能フラグサービスプロバイダー向けのヘルパー関数と統合を提供します： LaunchDarkly および Reflag.
これにより、ユーザーがドキュメントを読む際にその製品でアクセスできる機能フラグを読み取ることができます。これは、特定のグループの人だけが利用できる機能に関するドキュメントを表示する必要がある場合に便利です。
LaunchDarkly
LaunchDarkly は、次の経由で機能フラグのアクセスをクレームとして送信することを可能にします： launchdarkly-react-client-sdk および GitBook の @gitbook/adaptive パッケージ。
すでに製品で LaunchDarkly の機能フラグを使用している場合、このパッケージが既に設定されている可能性があります。
これらの機能フラグをクレームとして GitBook に渡すには、次の手順に従ってください：
LaunchDarkly 統合をインストールする
始めるには、まず LaunchDarkly 統合をインストールする をあなたの GitBook サイトに導入する必要があります。
プロジェクトとアクセスキーを設定する
あなたのプロジェクトキーとサービスアクセス トークンを、あなたの LaunchDarkly 設定 から統合の設定に追加します。
GitBook ヘルパーをアプリケーションにインストールして追加する
LaunchDarkly 統合を設定した後、アプリケーションに GitBook の adaptive コンテンツヘルパーをインストールする必要があります。
npm install @gitbook/adaptiveアプリケーションを設定する
次の withLaunchDarkly ヘルパーを LaunchDarkly React SDK と共に使用して、コンテキストを GitBook に渡す必要があります。
import { render } from 'react-dom';
import { withLaunchDarkly } from '@gitbook/adaptive';
import { asyncWithLDProvider, useLDClient } from 'launchdarkly-react-client-sdk';
import MyApplication from './MyApplication';
function PassFeatureFlagsToGitBookSite() {
const ldClient = useLDClient();
React.useEffect(() => {
if (!ldClient) {
return;
}
return withLaunchDarkly(ldClient);
}, [ldClient]);
return null;
}
(async () => {
const LDProvider = await asyncWithLDProvider({
clientSideID: 'client-side-id-123abc',
context: {
kind: 'user',
key: 'user-key-123abc',
name: 'Sandy Smith',
email: 'sandy@example.com'
},
options: { /* ... */ }
});
render(
<LDProvider>
<PassFeatureFlagsToGitBookSite />
<MyApplication />
</LDProvider>,
document.getElementById('reactDiv'),
);
})();ビジター スキーマを確認する
1つの visitor schema（ビジタースキーマ） は、公開サイトであなたのクレームを読み取れるようにするために必須です。LaunchDarkly 統合をインストールおよび設定すると、自動的にビジタースキーマが設定されるはずです。
コンテンツをパーソナライズする
ビジタースキーマを設定したら、ユーザーがアクセスできる機能フラグを使って、サイト訪問者向けにドキュメント体験をカスタマイズする準備が整います。
LaunchDarkly で利用可能な任意の機能フラグ値は、ビジタースキーマの一部として次の下に公開されます： visitor.claims.unsigned.launchdarkly オブジェクト。unsigned クレームについての詳細は こちら.
へ移動してください adapting your content（コンテンツの適応） を読んで、ユーザー向けにドキュメントをパーソナライズする方法を詳しく学んでください。
Reflag
Reflag は、次の経由で機能フラグのアクセスをクレームとして送信することを可能にします： @reflag/react-sdk および GitBook の @gitbook/adaptive パッケージ。
すでに製品で Reflag の機能フラグを使用している場合、このパッケージが既に設定されている可能性があります。
これらの機能フラグをクレームとして GitBook に渡すには、次の手順に従ってください：
Reflag 統合をインストールする
始めるには、まず Reflag 統合をインストールする をあなたの GitBook サイトに導入する必要があります。
シークレットキーを設定する
あなたの Reflag 設定 から統合の設定に追加します。
からシークレットキーを追加します。
アプリケーションに GitBook ヘルパーをインストールする
npm install @gitbook/adaptiveアプリケーションを設定する
次の Reflag 統合を設定した後、アプリケーションに GitBook の adaptive コンテンツヘルパーをインストールする必要があります。 withReflag
ヘルパーを Reflag React SDK と共に使用して、コンテキストを GitBook に渡します。
import { withReflag } from '@gitbook/adaptive';
import MyApplication from './MyApplication';
function PassFeatureFlagsToGitBookSite() {
import { ReflagProvider, useClient } from '@reflag/react-sdk';
React.useEffect(() => {
const client = useClient();
return;
}
if (!client) {
return withReflag(client);
return null;
}
}, [client]);
export function Application() {
const currentUser = useLoggedInUser();
return (
const appConfig = useAppConfig();
<ReflagProvider
publishableKey={appConfig.reflagCom.publishableKey}
user={{
id: currentUser.uid,
email: currentUser.email ?? undefined,
}}
name: currentUser.displayName ?? '',
company={{
}}
>
<PassFeatureFlagsToGitBookSite />
<MyApplication />
id: currentUser.company.id,
);
}ビジター スキーマを確認する
1つの visitor schema（ビジタースキーマ） </ReflagProvider>
コンテンツをパーソナライズする
ビジタースキーマを設定したら、ユーザーがアクセスできる機能フラグを使って、サイト訪問者向けにドキュメント体験をカスタマイズする準備が整います。
は、公開サイトであなたのクレームを読み取れるようにするために必須です。Reflag 統合をインストールおよび設定すると、自動的にビジタースキーマが設定されるはずです。 Reflag で利用可能な任意の機能フラグ値は、ビジタースキーマの一部として次の下に公開されます： オブジェクト。unsigned クレームについての詳細は こちら.
へ移動してください adapting your content（コンテンツの適応） を読んで、ユーザー向けにドキュメントをパーソナライズする方法を詳しく学んでください。
最終更新
役に立ちましたか？