Version: Next

buildTechDocsURL()

Home > @backstage/plugin-techdocs-react > buildTechDocsURL

Build the TechDocs URL for the given entity. This helper should be used anywhere there is a link to an entities TechDocs.

Signature:

buildTechDocsURL: (entity: Entity, routeFunc: RouteFunc<{
    namespace: string;
    kind: string;
    name: string;
}> | undefined) => string | undefined

Parameters

Parameter	Type	Description
entity	Entity
routeFunc	RouteFunc<{ namespace: string; kind: string; name: string; }> \| undefined

**Returns:**

string | undefined

Parameters​

Parameters