Backstage: Docs from backstage.io/docs having markdown as description

Created on 18 Aug 2020  Â·  4Comments  Â·  Source: backstage/backstage

E.g. https://backstage.io/docs/features/techdocs/techdocs-overview

TechDocs Documentation · Backstage
## What is it?

The problem being that .md files in /docs folder of the repo doesn't have description document header field (https://docusaurus.io/docs/en/doc-markdown#documents).

So the solution is to go through all files and add description for each one of them ;)

bug documentation good first issue

Most helpful comment

@shmidt-i Can I work on this issue?

All 4 comments

@shmidt-i Can I work on this issue?

@iamrajiv please do, thanks!

@stefanalund What should I give in description: should I give same as of title: in very .md file.

@iamrajiv can be first paragraph of the text, just cleared from image tags or any markdown.
E.g.
https://backstage.io/docs/overview/what-is-backstage
Screenshot 2020-09-14 at 15 45 42

Imagine string ![service-catalog]... being replaced by

Backstage is an open platform for building developer portals. Powered by a centralized service catalog, Backstage restores order to your microservices and infrastructure. So your product teams can ship high-quality code quickly — without compromising autonomy.

Backstage unifies all your infrastructure tooling, services, and documentation to create a streamlined development environment from end to end...
Was this page helpful?
0 / 5 - 0 ratings