backstage / backstage

Backstage is an open framework for building developer portals
https://backstage.io/
Apache License 2.0
27.52k stars 5.83k forks source link

Techdocs : Building a new version of this documentation failed : Error #10265

Closed dmdeepkp closed 2 years ago

dmdeepkp commented 2 years ago

Expected Behavior

Document should appear in Backstage UI for target repo under components

Actual Behavior

UI always displaying following error: "Building a new version of this documentation failed : Error" and nothing appears in build logs, it just says "waiting"

Steps to Reproduce

  1. Step 1 : This is content of app-config.yaml techdocs: requestUrl: http://localhost:7000/api/techdocs storageUrl: http://localhost:7000/api/techdocs/static/docs builder: 'external' # Alternatives - 'external' generator: runIn: 'local' # Alternatives - 'docker' publisher: type: 'local' # Alternatives - 'googleGcs' or 'awsS3'. Read documentation for using alternatives.

  2. Step 2 target repo has mkdocs.yml at root level which has content as: site_name: Root docs

nav:

plugins:

  1. Step 3 Also in target repo , there is a folder called as docs which has index.md file having following content: Docs for XYZ Service

4.Step 4 : Also in target repo there is catalog-info.yaml having following content:

apiVersion: backstage.io/v1alpha1 kind: Component metadata: name: xyzservice description: An example of a Backstage application.

Example for optional annotations

annotations:

github.com/project-slug: backstage/backstage

backstage.io/techdocs-ref: url:https://stash.trusted.visa.com:7990/projects/OP/repos/xyzservice/browse

spec: type: website owner: john@example.com lifecycle: development

Context

Your Environment

Dependencies: @backstage/app-defaults 0.1.5 @backstage/backend-common 0.10.4 @backstage/backend-tasks 0.1.4 @backstage/catalog-client 0.5.5, 0.9.0 @backstage/catalog-model 0.13.0, 0.9.10 @backstage/cli-common 0.1.6 @backstage/cli 0.12.0 @backstage/config-loader 0.9.3 @backstage/config 0.1.13, 0.1.15 @backstage/core-app-api 0.5.0 @backstage/core-components 0.8.7, 0.9.1 @backstage/core-plugin-api 0.6.0, 0.8.0 @backstage/errors 0.2.0, 0.2.2 @backstage/integration-react 0.1.19 @backstage/integration 0.7.2, 0.8.0 @backstage/plugin-api-docs 0.7.0 @backstage/plugin-app-backend 0.3.22 @backstage/plugin-auth-backend 0.7.0 @backstage/plugin-catalog-backend 0.21.0 @backstage/plugin-catalog-common 0.1.1 @backstage/plugin-catalog-graph 0.2.9 @backstage/plugin-catalog-import 0.7.10 @backstage/plugin-catalog-react 0.6.13, 0.9.0 @backstage/plugin-catalog 0.7.9 @backstage/plugin-github-actions 0.4.32 @backstage/plugin-org 0.4.0 @backstage/plugin-permission-common 0.4.0, 0.5.2 @backstage/plugin-permission-node 0.4.0 @backstage/plugin-permission-react 0.3.0, 0.3.3 @backstage/plugin-proxy-backend 0.2.16 @backstage/plugin-scaffolder-backend-module-cookiecutter 0.1.9 @backstage/plugin-scaffolder-backend 0.15.21 @backstage/plugin-scaffolder-common 0.1.3 @backstage/plugin-scaffolder 0.12.0 @backstage/plugin-search-backend-node 0.4.4 @backstage/plugin-search-backend 0.3.1 @backstage/plugin-search 0.5.6 @backstage/plugin-sonarqube 0.3.2 @backstage/plugin-tech-radar 0.5.3 @backstage/plugin-techdocs-backend 0.13.0 @backstage/plugin-techdocs 0.13.0 @backstage/plugin-user-settings 0.3.17 @backstage/search-common 0.2.1 @backstage/techdocs-common 0.11.4 @backstage/test-utils 0.2.3 @backstage/theme 0.2.14, 0.2.15 @backstage/types 0.1.1, 0.1.3 @backstage/version-bridge 0.1.1, 0.1.2 Done in 0.66s.

garyniemen commented 2 years ago

@dmdeepkp Is this still a problem for you?

github-actions[bot] commented 2 years ago

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

soapraj commented 2 years ago

Closing this issue for now. Please feel free to reopen if needed.