Files
backstage/.changeset/the-renegade-feeling.md
T
Eric Peterson 1bada775a9 Changesets for affected packages.
Signed-off-by: Eric Peterson <ericpeterson@spotify.com>
2021-11-28 13:16:04 -07:00

1.1 KiB

@backstage/create-app
@backstage/create-app
patch

TechDocs Backend may now (optionally) leverage a cache store to improve performance when reading content from a cloud storage provider.

To apply this change to an existing app, pass the cache manager from the plugin environment to the createRouter function in your backend:

// packages/backend/src/plugins/techdocs.ts

export default async function createPlugin({
  logger,
  config,
  discovery,
  reader,
+  cache,
}: PluginEnvironment): Promise<Router> {

  // ...

  return await createRouter({
    preparers,
    generators,
    publisher,
    logger,
    config,
    discovery,
+    cache,
  });

If your PluginEnvironment does not include a cache manager, be sure you've applied the cache management change to your backend as well.

Additional configuration is required if you wish to enable caching in TechDocs.