機能フラグ

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

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

現在、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 のアダプティブコンテンツヘルパーをアプリケーションにインストールする必要があります。

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

訪問者スキーマを確認する

1つ目は 訪問者スキーマ は、公開サイトでクレームを読み取れるようにするために必要です。LaunchDarkly 統合をインストールして設定すると、訪問者スキーマは自動的に設定されます。

6

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

訪問者スキーマを設定したら、ユーザーがアクセスできる機能フラグを使って、サイトを訪れるユーザー向けにドキュメント体験を調整する準備が整います。

LaunchDarkly で利用可能なあらゆる機能フラグの値は、訪問者スキーマの次の下に公開されます。 visitor.claims.unsigned.launchdarkly オブジェクト。署名なしクレームの詳細を読む を使って複数のクレームを条件エディタで組み合わせ、特定のユーザーに一致させることができます。演算子について詳しくは.

次へ移動します コンテンツを適応させる を読んで、ユーザー向けにドキュメントをさらにパーソナライズする方法をご確認ください。

Reflag

Reflag では、次を通じてクレームとして機能フラグへのアクセスを送信できます。 @reflag/react-sdk および GitBook の @gitbook/adaptive パッケージ。

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

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

1

Reflag 統合をインストールする

始めるには、まず Reflag 統合をインストールする GitBook サイトに追加する必要があります。

2

秘密鍵を設定する

次から秘密鍵を追加します。 Reflag の設定 からサービスアクセス トークンを統合の設定に追加します。

3

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

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

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

訪問者スキーマを確認する

1つ目は 訪問者スキーマ は、公開サイトでクレームを読み取れるようにするために必要です。Reflag 統合をインストールして設定すると、訪問者スキーマは自動的に設定されます。

6

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

訪問者スキーマを設定したら、ユーザーがアクセスできる機能フラグを使って、サイトを訪れるユーザー向けにドキュメント体験を調整する準備が整います。

Reflag で利用可能なあらゆる機能フラグの値は、訪問者スキーマの次の下に公開されます。 visitor.claims.unsigned.reflag オブジェクト。署名なしクレームの詳細を読む を使って複数のクレームを条件エディタで組み合わせ、特定のユーザーに一致させることができます。演算子について詳しくは.

次へ移動します コンテンツを適応させる を読んで、ユーザー向けにドキュメントをさらにパーソナライズする方法をご確認ください。

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