TechDocs: Update docs to use URL Reader over dir preparer

This commit is contained in:
Himanshu Mishra
2021-01-28 15:12:41 +01:00
parent 4bc89c555a
commit f680c6cd21
@@ -66,7 +66,9 @@ Update your component's entity description by adding the following lines to its
```yaml
metadata:
annotations:
backstage.io/techdocs-ref: dir:./
backstage.io/techdocs-ref: url:https://github.com/org/repo
# Or
# backstage.io/techdocs-ref: url:https://github.com/org/repo/tree/branchName/subFolder
```
Create a `/docs` folder in the root of the project with at least an `index.md`