Merge pull request #10252 from backstage/emmaindal/update-techdocs-documentation

[TechDocs] update documentation
This commit is contained in:
Emma Indal
2022-03-20 21:08:51 +01:00
committed by GitHub
3 changed files with 13 additions and 37 deletions
+13 -19
View File
@@ -74,32 +74,26 @@ providers are used.
storage solutions, source control systems).
- [Instructions for upgrading from Alpha to Beta](how-to-guides.md#how-to-migrate-from-techdocs-alpha-to-beta)
**v1**
TechDocs packages:
- '@backstage/plugin-techdocs'
- '@backstage/plugin-techdocs-backend'
- '@backstage/plugin-techdocs-node'
- '@techdocs/cli'
was promoted to v1.0! To understand how this change affects the package, please check out our [versioning policy](https://backstage.io/docs/overview/versioning-policy).
### **Future work 🔮**
**General Availability (GA) release** -
[Milestone](https://github.com/backstage/backstage/milestone/30)
- Bugs are rare, TechDocs APIs are stable and scales easily in large
organizations.
- Better integration with
[Scaffolder V2](https://github.com/backstage/backstage/issues/2771) (e.g. easy
to choose and plug documentation template with Software Templates).
- Static site generator agnostic
- Possible to configure several aspects about TechDocs (e.g. URL, homepage,
theme).
**Implement Feedback loop** -
[Milestone](https://github.com/backstage/backstage/milestone/31)
- A feedback loop between documentation reader and writer using TechDocs
- The `+` in `docs-like-code+` experience
**TechDocs widget framework**
Platformize TechDocs with a widget framework so that it is easy for TechDocs
contributors to add pieces of functionality and for users to choose which
functionalities they want to adopt. As a pre-requisite, the re-architecture of
TechDocs frontend [RFC](https://github.com/backstage/backstage/issues/3998)
needs to be addressed.
- [TechDocs Addon Framework](https://github.com/backstage/backstage/issues/9636)
## Tech stack
-12
View File
@@ -131,15 +131,3 @@ layer for users to determine whether they have the permission to view a
particular docs site. There are a handful of features which are extremely hard
to develop without a tightly integrated backend in place. Hence, support for
`techdocs` without `techdocs-backend` is limited and challenging to develop.
# Future work
_Ideas here are far fetched and not in the project's milestone for near future
(~6 months)._
We currently depend on MkDocs to parse doc sites written in Markdown. And we
store the generated static assets and re-use it later to render in Backstage. A
better (futuristic) approach will be to directly parse whatever type of source
files you have in your docs repository and directly render in Backstage in
real-time. You can read more in this
[RFC - Simplifying TechDocs Frontend Architecture](https://github.com/backstage/backstage/issues/3998).
-6
View File
@@ -160,10 +160,4 @@ techdocs:
# object was not found (e.g. when the cache sercice is unavailable). The
# default value is 1000
readTimeout: 500
# (Optional and Legacy) Just another route in techdocs-backend where TechDocs requests the static files from. This URL uses an HTTP middleware
# to serve files from either a local directory or an External storage provider.
# You don't have to specify this anymore.
storageUrl: http://localhost:7007/api/techdocs/static/docs
```