Drapeaux de fonctionnalité

Transmettez les données des visiteurs dans vos docs via un fournisseur de drapeaux de fonctionnalité.

L'utilisation de contenu adaptatif avec des indicateurs de fonctionnalités 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 de services d'indicateurs de fonctionnalités populaires comme LaunchDarkly et Bucket.

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

LaunchDarkly

LaunchDarkly vous permet d'envoyer l'accès aux indicateurs de fonctionnalités comme des revendications via le launchdarkly-react-client-sdk et le @gitbook/adaptive package de GitBook.

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

Pour vous transmettre ces indicateurs de fonctionnalités comme des revendications à GitBook, suivez ces étapes :

Installez l'intégration LaunchDarkly

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

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

Ajoutez la clé de votre projet et votre jeton d'accès au service depuis vos paramètres LaunchDarkly à 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 le withLaunchDarkly 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 de visiteur

Un schéma de visiteur est requis afin 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 de visiteur.

Personnalisez votre contenu

Après avoir défini votre schéma de visiteur, vous êtes prêt à adapter l'expérience de vos documents pour les utilisateurs visitant votre site, en utilisant les indicateurs de fonctionnalités auxquels l'utilisateur a accès.

Toute valeur d'indicateur de fonctionnalité disponible dans LaunchDarkly sera exposée dans le schéma de visiteur sous unsigned.launchdarkly.flags objet. En savoir plus sur les revendications non signées ici.

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

Bucket

Bucket vous permet d'envoyer l'accès aux indicateurs de fonctionnalités comme des revendications via le @bucketco/react-sdk et le @gitbook/adaptive package de GitBook.

Si vous utilisez déjà les indicateurs de fonctionnalités Bucket dans votre produit, il y a de fortes chances que ce package soit déjà configuré.

Pour vous transmettre ces indicateurs de fonctionnalités comme des revendications à GitBook, suivez ces étapes :

Installez l'intégration Bucket

Pour commencer, vous devez d'abord installez l'intégration Bucket sur votre site GitBook.

Configurez votre clé secrète

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

Installez l'assistant GitBook dans votre application

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

npm install @gitbook/adaptive

Configurez votre application

Vous devrez utiliser le withBucket assistant avec le SDK React Bucket pour transmettre le contexte à GitBook.

import { withBucket } from '@gitbook/adaptive';
import { BucketProvider, useClient } from '@bucketco/react-sdk';
import MyApplication from './MyApplication';

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

Vérifiez votre schéma de visiteur

Un schéma de visiteur est requis afin que vos revendications puissent être lues sur votre site publié. L'installation et la configuration de l'intégration Bucket devraient automatiquement définir votre schéma de visiteur.

Personnalisez votre contenu

Toute valeur d'indicateur de fonctionnalité disponible dans Bucket sera exposée dans le schéma de visiteur sous unsigned.bucket.flags objet. En savoir plus sur les revendications non signées ici.

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

Les valeurs des indicateurs de fonctionnalités 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 24 jours

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