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.

TechDocs returning "ERROR 404: i: Page not found"

See original GitHub issue

Expected Behavior

TechDocs should generate docs properly when opening a docs component from the main menu.

Current Behavior

When opening a Docs site that is configured to use either github or azure devops, you get a 404 error page suggesting that perhaps you are missing an index.md but if you look at the browser console there is a 404 error loading an index.html from an API route. However, there seems to be an issue with the URL itself. Once I change the part of the URL from lower to upper case (“component” to “Component”), everything works fine. Also, when opening techdocs directly from the catalog (https://backstage.xxx.com/catalog/default/component/xxx/docs), it works fine.

Possible Solution

Currently, the following URL is opened after clicking on the techdoc: https://backstage.xxx.com/docs/default/component/xxx

It works after changing the “Component” to upper case: https://backstage.xxx.com/docs/default/Component/xxx

Steps to Reproduce

Generate app using @backstage/create-app @0.3.38
Integrate component with a techdoc from Azure or Github
Open integrated component from the main menu (Docs -> component name)

Context

Error text displayed in UI:

ERROR 404: i: Page not found. This could be because there is no index.md file in the root of the docs directory of this repository.

Looks like someone dropped the mic!
Go back... or please contact support if you think this is a bug.

Your Environment

Docker image based on node:14-buster-slim
App generated using: @backstage/create-app@0.3.38
Edge / Chrome / Firefox

Issue Analytics

State:
Created 2 years ago
Comments:14 (14 by maintainers)

Top GitHub Comments

2reactions

camilaibscommented, Aug 30, 2021

@camilaibs would you agree? Can we maybe get some support/guidance on this one from the devs?

@nadworny the pull request that fixes this issue is being reviewed to be included in the next Backstage release and a workaround solution has been shared in the discord here.

1reaction

iamEAPcommented, Sep 5, 2021

Thanks for the patience, all! The latest version of @backstage/create-app should have this fix. If you have an existing deployment of Backstage, you should be able to bump versions and get the fix. Manually updating to the following versions will also work:

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

Top Results From Across the Web

You get a 404 page not found error - Akamai TechDocs

If you get a 404 page not found error when making an authorization request, that means that problem is somewhere in your Hosted...

Web Services URL Validation Fails with Status Code 404

The error is due to a wrong Web Services URL. Solution: Check for any typos in the Web Services URL. Example: https://<APPLICATION_SERVER_HOST> ...

The remote server returned an error: (404) Not Found

Log in to the website; Navigate to Administration > Sites & Settings; Select the site on the left hand site; For each site,...

Why won't my PHP app send a 404 error? - Stack Overflow

FWIW, incase of 404, IE returns its standard 'not found' page if the content is short (it assumes the server is just saying...

Troubleshooting TechDocs - Backstage.io

MkDocs Build Errors. Using the TechDocs CLI, you can troubleshoot MkDocs build issues locally. Note this requires you have Docker available to launch...