RecommendedDeploymentOptions

Home > @backstage/plugin-techdocs-backend > RecommendedDeploymentOptions

Required dependencies for running TechDocs in the "recommended" deployment configuration (prepare/generate handled externally in CI/CD).

Signature:

export type RecommendedDeploymentOptions = {
    publisher: PublisherBase;
    logger: winston.Logger;
    discovery: PluginEndpointDiscovery;
    config: Config;
    cache: PluginCacheManager;
    docsBuildStrategy?: DocsBuildStrategy;
    buildLogTransport?: winston.transport;
    catalogClient?: CatalogClient;
    httpAuth?: HttpAuthService;
    auth?: AuthService;
};

References: PublisherBase, PluginEndpointDiscovery, Config, PluginCacheManager, DocsBuildStrategy, CatalogClient, HttpAuthService, AuthService