PublisherBase.fetchTechDocsMetadata()

Home > @backstage/plugin-techdocs-node > PublisherBase > fetchTechDocsMetadata

Retrieve TechDocs Metadata about a site e.g. name, contributors, last updated, etc. This API uses the techdocs_metadata.json file that co-exists along with the generated docs.

Signature:

fetchTechDocsMetadata(entityName: CompoundEntityRef): Promise<TechDocsMetadata>;

Parameters

Parameter	Type	Description
entityName	CompoundEntityRef

Returns:

Promise<TechDocsMetadata>