diff --git a/.changeset/stale-dots-love.md b/.changeset/stale-dots-love.md new file mode 100644 index 0000000000..46327937f0 --- /dev/null +++ b/.changeset/stale-dots-love.md @@ -0,0 +1,5 @@ +--- +'@backstage/plugin-tech-insights-backend': patch +--- + +Add Documentation on 404 Errors diff --git a/plugins/tech-insights-backend/README.md b/plugins/tech-insights-backend/README.md index 26dac78db5..95fa3ccda9 100644 --- a/plugins/tech-insights-backend/README.md +++ b/plugins/tech-insights-backend/README.md @@ -213,6 +213,8 @@ and modify the `techInsights.ts` file to contain a reference to the FactChecker }); ``` +NOTE: You need a Fact Checker Factory to get access to the backend routes that will allow the facts to be checked. If you don't have a Fact Checker Factory you will see 404s and potentially other errors. + To be able to run checks, you need to additionally add individual checks into your FactChecker implementation. For examples how to add these, you can check the documentation of the individual implementation of the FactChecker #### Modifying check persistence