From 40298b02778c34f4c63c898a19cd4155bcb2fda2 Mon Sep 17 00:00:00 2001 From: Brian Fletcher Date: Tue, 14 Feb 2023 08:44:52 +0000 Subject: [PATCH] docs error more explanatory Signed-off-by: Brian Fletcher --- .changeset/flat-peaches-act.md | 5 +++++ plugins/techdocs-backend/src/service/DocsSynchronizer.ts | 2 +- 2 files changed, 6 insertions(+), 1 deletion(-) create mode 100644 .changeset/flat-peaches-act.md diff --git a/.changeset/flat-peaches-act.md b/.changeset/flat-peaches-act.md new file mode 100644 index 0000000000..577e17231f --- /dev/null +++ b/.changeset/flat-peaches-act.md @@ -0,0 +1,5 @@ +--- +'@backstage/plugin-techdocs-backend': patch +--- + +Techdocs backend explains a bit more about about what might have caused the docs not being found when building techdocs. diff --git a/plugins/techdocs-backend/src/service/DocsSynchronizer.ts b/plugins/techdocs-backend/src/service/DocsSynchronizer.ts index 3d89d1647f..8456f64a6a 100644 --- a/plugins/techdocs-backend/src/service/DocsSynchronizer.ts +++ b/plugins/techdocs-backend/src/service/DocsSynchronizer.ts @@ -165,7 +165,7 @@ export class DocsSynchronizer { ); error( new NotFoundError( - 'Sorry! It took too long for the generated docs to show up in storage. Check back later.', + 'Sorry! It took too long for the generated docs to show up in storage. Are you sure the docs project is generating an `index.html` file? Otherwise, check back later.', ), ); return;