機能フラグ

機能フラグプロバイダーを通じて、訪問者データをドキュメントに渡します

アダプティブコンテンツを機能フラグと併用するには、アプリケーションにコードを追加する必要があります。

現在、GitBook ヘルパーは React ベースのセットアップのみをサポートしています。

GitBook は、次のような一般的なフィーチャーフラグサービスプロバイダー向けにヘルパー関数と統合機能を提供しています。 LaunchDarkly 、 Reflag.

これにより、ドキュメントを読むユーザーが製品内でアクセスできるフィーチャーフラグを読み取れます。これは、特定のグループの人だけが利用できる機能のドキュメントを表示する必要がある場合に便利です。

LaunchDarkly

LaunchDarkly では、フィーチャーフラグのアクセス権を次の経由でクレームとして送信できます。 launchdarkly-react-client-sdk および GitBook の @gitbook/adaptive パッケージです。

すでに製品で LaunchDarkly のフィーチャーフラグを使用している場合、このパッケージはすでに設定済みである可能性が高いです。

これらのフィーチャーフラグをクレームとして GitBook に渡すには、次の手順に従ってください：

1

LaunchDarkly の統合をインストール

開始するには、まず LaunchDarkly の統合をインストールする必要があります を GitBook サイトに。

2

プロジェクトとアクセスキーを設定する

次の場所からプロジェクトキーとサービスアクセストークンを追加してください： LaunchDarkly の設定 を統合の設定に追加します。

3

GitBook ヘルパーをアプリケーションにインストールして追加する

LaunchDarkly の統合を設定した後、GitBook のアプリケーションに GitBook の adaptive content ヘルパーをインストールする必要があります。

npm install @gitbook/adaptive

4

アプリケーションを設定する

次を使用する必要があります： 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: '[e-mail]'
        },
        options: { /* ... */ }
    });
    render(
        <LDProvider>
            <PassFeatureFlagsToGitBookSite />
            <MyApplication />
        </LDProvider>,
        document.getElementById('reactDiv'),
    );
})();

5

visitor スキーマを確認する

1つの visitor スキーマ 公開サイトでクレームを読み取れるようにするには必須です。LaunchDarkly の統合をインストールして設定すると、visitor スキーマは自動的に設定されるはずです。

6

コンテンツをパーソナライズする

visitor スキーマを設定したら、ユーザーがアクセスできるフィーチャーフラグを使って、サイトを訪れるユーザー向けにドキュメント体験を調整できるようになります。

LaunchDarkly で利用可能なフィーチャーフラグの値はすべて、visitor スキーマの一部として次の下に公開されます： visitor.claims.unsigned.launchdarkly オブジェクト。署名なしクレームの詳細を見る こちら.

に移動します コンテンツの適応 ユーザー向けにドキュメントをパーソナライズする方法の詳細を確認してください。

Reflag

Reflag では、フィーチャーフラグのアクセス権を次の経由でクレームとして送信できます。 @reflag/react-sdk および GitBook の @gitbook/adaptive パッケージです。

すでに製品で Reflag のフィーチャーフラグを使用している場合、このパッケージはすでに設定済みである可能性が高いです。

これらのフィーチャーフラグをクレームとして GitBook に渡すには、次の手順に従ってください：

1

Reflag の統合をインストール

開始するには、まず Reflag の統合をインストールする を GitBook サイトに。

2

シークレットキーを設定する

次の場所からシークレットキーを追加してください： Reflag の設定 を統合の設定に追加します。

3

GitBook ヘルパーをアプリケーションにインストールする

Reflag の統合を設定した後、GitBook のアプリケーションに GitBook の adaptive content ヘルパーをインストールする必要があります。

npm install @gitbook/adaptive

4

アプリケーションを設定する

次を使用する必要があります： withReflag Reflag React SDK とともにこのヘルパーを使って、コンテキストを GitBook に渡します。

import { withReflag } from '@gitbook/adaptive';
import { ReflagProvider, useClient } from '@reflag/react-sdk';
import MyApplication from './MyApplication';

function PassFeatureFlagsToGitBookSite() {
    const client = useClient();
    React.useEffect(() => {
        if (!client) {
            return;
        }
        return withReflag(client);
    }, [client]);
    return null;
}
export function Application() {
    const currentUser = useLoggedInUser();
    const appConfig = useAppConfig();
    return (
        <ReflagProvider
            publishableKey={appConfig.reflagCom.publishableKey}
            user={{
                id: currentUser.uid,
                email: currentUser.email ?? undefined,
                name: currentUser.displayName ?? '',
            }}
            company={{
                id: currentUser.company.id,
            }}
        >
            <PassFeatureFlagsToGitBookSite />
            <MyApplication />
        </ReflagProvider>
    );
}

5

visitor スキーマを確認する

1つの visitor スキーマ 公開サイトでクレームを読み取れるようにするには必須です。Reflag の統合をインストールして設定すると、visitor スキーマは自動的に設定されるはずです。

6

コンテンツをパーソナライズする

visitor スキーマを設定したら、ユーザーがアクセスできるフィーチャーフラグを使って、サイトを訪れるユーザー向けにドキュメント体験を調整できるようになります。

Reflag で利用可能なフィーチャーフラグの値はすべて、visitor スキーマの一部として次の下に公開されます： visitor.claims.unsigned.reflag オブジェクト。署名なしクレームの詳細を見る こちら.

に移動します コンテンツの適応 ユーザー向けにドキュメントをパーソナライズする方法の詳細を確認してください。

フィーチャーフラグの値はクライアント側で評価されるため、機密データやセキュリティ上重要なデータを渡すためにこの方法を使用するのは避けてください。