question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

docs are not available from UI latest backstage version

See original GitHub issue
  1. I have component definition like
apiVersion: backstage.io/v1alpha1
kind: Component
metadata:
  name: my-service
  description: |
    Main brain
  tags:
    - kotlin
  links:
    - title: Playbook entry
      url: https://domain.com/playbook/services/my-service.html
  annotations:
    backstage.io/source-location: url:https://gitlab.domain.com/xxx/my-service
    backstage.io/techdocs-ref: url:https://gitlab.domain.com/xxx/my-backstage/-/tree/master/my-service
spec:
  type: service
  owner: myteam
  lifecycle: production
  dependsOn: ['component:talon-one']
  providesApis: ['my-service-api']
  1. Then backstage parses docs and displays them on the docs index page
  2. When I click on the record, it says “dropped the mic!” and I see that it tries to query https://domain.com/api/techdocs/static/docs/default/component/my-service/index.html (returns 404)
  3. I see that https://domain.com/api/techdocs/static/docs/default/Component/my-service/index.html returns content

Expected Behavior

Documentation is shown

Current Behavior

Error is shown

Possible Solution

When I login into the container I can manually rename folder to lowercase and it starts to show it:

root@backstage-75cf748684-7rl9n:/# cd /app/node_modules/@backstage/plugin-techdocs-backend/static/docs/default/
root@backstage-75cf748684-7rl9n:/app/node_modules/@backstage/plugin-techdocs-backend/static/docs/default# ls
Component
root@backstage-75cf748684-7rl9n:/app/node_modules/@backstage/plugin-techdocs-backend/static/docs/default# mv Component component

Context

I’ve updated backstage with yarn backstage-cli versions:bump and did all necessary patch changes and now documentation is not working. Another thing which is related to this issue is that DefaultTechDocsCollator queries /api/techdocs/static/docs/default/Component/my-service/search/search_index.json (capitalised “Kind”). So I can not just rename that folder, because then collator does not work.

It is also worth to mention, that DefaultTechDocsCollator queries an url with capitalised C: /api/techdocs/static/docs/default/Component/my-service/search/search_index.json. So there is currently some misalignment. Maybe both variants shall be served, from the back-end perspective.

Your Environment

Docker container build on top of FROM node:14-buster-slim

Issue Analytics

  • State:closed
  • Created 2 years ago
  • Reactions:1
  • Comments:8 (5 by maintainers)

github_iconTop GitHub Comments

2reactions
iamEAPcommented, Sep 5, 2021

Thanks for the patience, all! In your existing Backstage deployment, you should be able to bump versions and get the fix for this. Manually updating to the following versions should also work:

  • @backstage/plugin-techdocs - v0.11.1
  • @backstage/plugin-techdocs-backend - v0.10.1

(If you used the workaround, you will naturally want to revert that configuration)

2reactions
PavelPolyakovcommented, Aug 30, 2021

This can be temporary fixed by providing configuration:

techdocs:
  legacyUseCaseSensitiveTripletPaths: true
Read more comments on GitHub >

github_iconTop Results From Across the Web

Techdocs : Building a new version of this documentation failed ...
UI always displaying following error: "Building a new version of this documentation failed : Error" and nothing appears in build logs, ...
Read more >
FAQ · Backstage Software Catalog and Developer Platform
No, but it can be! Backstage is designed to be a developer portal for all your infrastructure tooling, services, and documentation.
Read more >
@backstage/plugin-api-docs - npm
A Backstage plugin that helps represent API entities in the frontend. Latest version: 0.8.13, last published: a day ago.
Read more >
AM 6 > Release Notes - ForgeRock Backstage
Notes covering new features, fixes and known issues in ForgeRock® Access Management. ForgeRock Access Management provides authentication, authorization, ...
Read more >
Cannot create docs for components in backstage docker error
I was getting similar issues working on a local POC of Backstage. The biggest problem was that I needed to install pip, python,...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found