Indicateurs de fonctionnalité

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

L’utilisation de contenu adaptatif avec des drapeaux de fonctionnalité nécessite d’ajouter du code à votre application.

À l’heure actuelle, 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 les fournisseurs populaires de services de drapeaux de fonctionnalité comme LaunchDarkly et Reflag.

Cela vous permet de lire les drapeaux de fonctionnalité auxquels les utilisateurs ont accès dans votre produit, pendant qu’ils lisent votre documentation. C’est utile si vous devez afficher de la documentation pour des fonctionnalités qui ne sont disponibles que pour un groupe de personnes spécifique.

LaunchDarkly

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

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

Pour vous transmettre ces drapeaux de fonctionnalité sous forme de revendications vers GitBook, suivez ces étapes :

Installez l’intégration LaunchDarkly

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

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

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

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

Configurez votre application

Vous devrez utiliser withLaunchDarkly l’assistant avec le SDK React 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: 'sandy@example.com'
        },
        options: { /* ... */ }
    });
    render(
        <LDProvider>
            <PassFeatureFlagsToGitBookSite />
            <MyApplication />
        </LDProvider>,
        document.getElementById('reactDiv'),
    );
})();

Vérifiez votre schéma du visiteur

Un schéma du visiteur est nécessaire pour que vos revendications puissent être lues sur votre site publié. L’installation et la configuration de l’intégration LaunchDarkly devraient automatiquement définir votre schéma du visiteur.

Personnalisez votre contenu

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

Toute valeur de drapeau de fonctionnalité disponible dans LaunchDarkly sera exposée dans le schéma du visiteur sous l’objet visitor.claims.unsigned.launchdarkly En savoir plus sur les revendications non signées ici.

Rendez-vous sur l’adaptation de 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 drapeaux de fonctionnalité sous forme de revendications via le @reflag/react-sdk et le @gitbook/adaptive package.

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

Pour vous transmettre ces drapeaux de fonctionnalité sous forme de revendications vers GitBook, suivez ces étapes :

Installez l’intégration Reflag

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

Configurez votre clé secrète

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

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

Configurez votre application

Vous devrez utiliser withReflag l’assistant 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>
    );
}

Vérifiez votre schéma du visiteur

Un schéma du visiteur est nécessaire pour que vos revendications puissent être lues sur votre site publié. L’installation et la configuration de l’intégration Reflag devraient automatiquement définir votre schéma du visiteur.

Personnalisez votre contenu

Toute valeur de drapeau de fonctionnalité disponible dans Reflag sera exposée dans le schéma du visiteur sous l’objet visitor.claims.unsigned.reflag En savoir plus sur les revendications non signées ici.

Rendez-vous sur l’adaptation de votre contenu pour en savoir plus sur la personnalisation de votre documentation pour vos utilisateurs.

Les valeurs des drapeaux de fonctionnalité 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é.

Mis à jour il y a 2 mois

Ce contenu vous a-t-il été utile ?