Indicateurs de fonctionnalité

Transmettez les données des visiteurs à votre documentation via un fournisseur d’indicateurs de fonctionnalité

L’utilisation du contenu adaptatif avec des indicateurs de fonctionnalité nécessite l’ajout de code à votre application.

Actuellement, l’assistant GitBook ne prend en charge que les configurations basées sur React.

GitBook fournit des fonctions d’assistance et des intégrations pour des fournisseurs populaires de services de feature flags comme LaunchDarkly et Reflag.

Cela vous permet de lire les feature flags auxquels les utilisateurs ont accès dans votre produit, au fur et à mesure qu’ils consultent votre documentation. C’est utile si vous devez afficher une documentation pour des fonctionnalités qui ne sont disponibles qu’à un groupe spécifique de personnes.

LaunchDarkly

LaunchDarkly vous permet d’envoyer l’accès aux feature flags sous forme de claims via le launchdarkly-react-client-sdk et le package @gitbook/adaptive .

Si vous utilisez déjà des feature flags LaunchDarkly dans votre produit, il y a de fortes chances que ce package soit déjà configuré.

Pour transmettre ces feature flags sous forme de claims à GitBook, suivez ces étapes :

1

Installez l’intégration LaunchDarkly

Pour commencer, vous devrez d’abord installer l’intégration LaunchDarkly sur votre site GitBook.

2

Configurez votre projet et vos clés d’accès

Ajoutez la clé de votre projet et votre jeton d’accès de service depuis vos paramètres LaunchDarkly à la configuration de l’intégration.

3

Installez et ajoutez l’assistant GitBook à votre application

Après avoir configuré l’intégration LaunchDarkly, vous devrez installer l’assistant de contenu adaptatif GitBook dans votre application.

npm install @gitbook/adaptive

4

Configurez votre application

Vous devrez utiliser l’assistant withLaunchDarkly avec le SDK React de LaunchDarkly pour transmettre le contexte à 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

Vérifiez votre schéma de visiteur

Un schéma de visiteur est requis pour que vos claims puissent être lus sur votre site publié. L’installation et la configuration de l’intégration LaunchDarkly devraient définir automatiquement votre schéma de visiteur pour vous.

6

Personnalisez votre contenu

Après avoir défini votre schéma de visiteur, vous êtes prêt à adapter l’expérience de votre documentation aux utilisateurs qui visitent votre site, en utilisant les feature flags auxquels l’utilisateur a accès.

Toute valeur de feature flag disponible dans LaunchDarkly sera exposée dans le schéma de visiteur sous l’objet visitor.claims.unsigned.launchdarkly . En savoir plus sur les claims non signés ici.

Accédez à adapter votre contenu pour en savoir plus sur la personnalisation de votre documentation pour vos utilisateurs.

Reflag

Reflag vous permet d’envoyer l’accès aux feature flags sous forme de claims via le @reflag/react-sdk et le package @gitbook/adaptive .

Si vous utilisez déjà des feature flags Reflag dans votre produit, il y a de fortes chances que ce package soit déjà configuré.

Pour transmettre ces feature flags sous forme de claims à GitBook, suivez ces étapes :

1

Installez l’intégration Reflag

Pour commencer, vous devrez d’abord installer l’intégration Reflag sur votre site GitBook.

2

Configurez votre clé secrète

Ajoutez votre clé secrète depuis vos paramètres Reflag à la configuration de l’intégration.

3

Installez l’assistant GitBook dans votre application

Après avoir configuré l’intégration Reflag, vous devrez installer l’assistant de contenu adaptatif GitBook dans votre application.

npm install @gitbook/adaptive

4

Configurez votre application

Vous devrez utiliser l’assistant withReflag avec le SDK React Reflag pour transmettre le contexte à 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

Vérifiez votre schéma de visiteur

Un schéma de visiteur est requis pour que vos claims puissent être lus sur votre site publié. L’installation et la configuration de l’intégration Reflag devraient définir automatiquement votre schéma de visiteur pour vous.

6

Personnalisez votre contenu

Après avoir défini votre schéma de visiteur, vous êtes prêt à adapter l’expérience de votre documentation aux utilisateurs qui visitent votre site, en utilisant les feature flags auxquels l’utilisateur a accès.

Toute valeur de feature flag disponible dans Reflag sera exposée dans le schéma de visiteur sous l’objet visitor.claims.unsigned.reflag . En savoir plus sur les claims non signés ici.

Accédez à adapter votre contenu pour en savoir plus sur la personnalisation de votre documentation pour vos utilisateurs.

Les valeurs des feature flags sont évaluées côté client, évitez donc d’utiliser cette méthode pour transmettre des données sensibles ou critiques pour la sécurité.