From 597f7a604de4d710ae47de14e54e0b9f198b2e81 Mon Sep 17 00:00:00 2001 From: Joe Porpeglia Date: Fri, 14 Jan 2022 14:28:54 -0500 Subject: [PATCH] Update changeset Signed-off-by: Joe Porpeglia --- .changeset/giant-bees-speak.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.changeset/giant-bees-speak.md b/.changeset/giant-bees-speak.md index 65362e1c3c..e481fa16ec 100644 --- a/.changeset/giant-bees-speak.md +++ b/.changeset/giant-bees-speak.md @@ -4,6 +4,6 @@ **BREAKING**: The `cache` option is now required by `createRouter`. -Added catalog-based authorization to TechDocs backend. When permissions are enabled for Backstage (via the `permission.enabled` config) the current user must have read access to the doc's corresponding catalog entity. The backend will return a 404 if the current user doesn't have access. +Added catalog-based authorization to TechDocs backend. When permissions are enabled for Backstage (via the `permission.enabled` config) the current user must have read access to the doc's corresponding catalog entity. The backend will return a 404 if the current user doesn't have access or if the entity doesn't exist. Entities are cached to for a short time to optimize the `/static/docs` request path, which can be called many times when loading a single TechDocs page. -Note: Custom TechDocs setups that expose docs without a corresponding catalog entity will not work with permissions enabled, but a solution for this will be provided in the future. +Note: If you publish your TechDocs documentation to storage in a custom way under paths that do not conform to the default `:namespace/:kind/:name` pattern, then TechDocs will not work with permissions enabled. We want understand these use cases better and provide a solution in the future, so reach out to us on Discord in the [#docs-like-code](https://discord.com/channels/687207715902193673/714754240933003266) channel if you would like to help out.