paulononato/backstage
1
0
Fork 0
Code Issues Pull Requests Actions 20 Packages Projects Releases Wiki Activity

techdocs: replace 'build' with 'generate' in most places

Browse Source
This commit is contained in:
Himanshu Mishra
2020-12-09 16:01:29 +01:00
parent 9bd130a73a
commit 9d08ef8f46
5 changed files with 12 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/features/techdocs/architecture.md
+4 -4
View File
@@ -50,7 +50,7 @@ built.
We assume each entity lives in a repository somewhere (GitHub, GitLab, etc.). We
recommend using a CI/CD pipeline with the repository that has a dedicated
step/job to build docs for TechDocs. The generated static files are then stored
step/job to generate docs for TechDocs. The generated static files are then stored
in a cloud storage solution of your choice.
[Track progress here](https://github.com/backstage/backstage/issues/3096).
@@ -60,9 +60,9 @@ your configured storage solution for the necessary files and returns them to
TechDocs Reader.
We will provide instructions, scripts and/or templates (e.g. GitHub actions) to
build docs in your CI/CD system.
generate docs in your CI/CD system.
[Track progress here.](https://github.com/backstage/backstage/issues/3400) You
will be able to use `techdocs-cli` to build docs and publish the generated docs
will be able to use `techdocs-cli` to generate docs and publish the generated docs
site files to your cloud storage system.
Note about caching: We have noticed internally that some storage providers can
@@ -120,7 +120,7 @@ docs site in real-time?**
A: Generating the content from Markdown on the fly is not optimal (although that
is how the basic out-of-the-box setup is implemented). Storage solutions act as
a cache for the generated static content. TechDocs is also currently built on
MkDocs which does not allow us to build docs per-page, so we would have to build
MkDocs which does not allow us to generate docs per-page, so we would have to build
all docs for a entity on every request.
# Future work
docs/features/techdocs/configuration.md
+2 -2
View File
@@ -36,9 +36,9 @@ techdocs:
# techdocs.builder can be either 'local' or 'external.
# If builder is set to 'local' and you open a TechDocs page, techdocs-backend will try to build the docs, publish to storage
# If builder is set to 'local' and you open a TechDocs page, techdocs-backend will try to generate the docs, publish to storage
# and show the generated docs afterwords. This is the "Basic" setup of the TechDocs Architecture.
# If builder is set to 'external', techdocs-backend will only fetch the docs and will NOT try to build and publish. In this case of 'external',
# If builder is set to 'external', techdocs-backend will only fetch the docs and will NOT try to generate and publish. In this case of 'external',
# we assume that docs are being built by an external process (e.g. in the CI/CD pipeline of the repository). This is the "Recommended" setup of
# the architecture. Read more here https://backstage.io/docs/features/techdocs/architecture