697e899396
Merge pull request #12305 from Niksko/techdocs-cache-docs
...
Explain how to enable techdocs cache
2022-06-29 15:07:16 +02:00
858390e571
Merge pull request #12197 from awanlin/topic/add-addon-package-install
...
Added details about installing addons package
2022-06-29 13:57:44 +02:00
79639013b5
Explain how to enable techdocs cache
...
For dummies like me, it took me a while to figure out that even if you
have configured the backend cache, the TechDocs cache is not enabled
until you set a value for the TTL. My interpretation was that it was
just configured by default, and the fact that a default value for ttl
seems to appear here points to that as well.
This change hopes to make this explicit, to avoid others spinning their
wheels like I have.
Signed-off-by: Nikolas Skoufis <nskoufis@seek.com.au >
2022-06-29 17:38:41 +10:00
e271183fe7
Added example for custom reader page
...
Signed-off-by: Andre Wanlin <67169551+awanlin@users.noreply.github.com >
2022-06-23 10:54:24 -05:00
dabbb286f7
Corrected typos
...
Signed-off-by: Andre Wanlin <67169551+awanlin@users.noreply.github.com >
2022-06-22 06:58:23 -05:00
2b74a85059
Added details about installing addons package
...
Signed-off-by: Andre Wanlin <67169551+awanlin@users.noreply.github.com >
2022-06-21 17:42:31 -05:00
860765ff45
[TechDocs] Added configuration for local publishing target
...
This patch adds a configuration option for setting the "local"
techdocs target directory. The target directory can be set using
the "techdocs.publisher.local.publishDirectory".
This fixes two "TODOs" in the "plugins/techdocs-node/src/stages
/publish/local.ts" file:
* Use a more persistent storage than node_modules or /tmp directory.
Make it configurable with techdocs.publisher.local.publishDirectory
* Move the logic of setting staticDocsDir based on config over to
fromConfig, and set the value as a class parameter.
Signed-off-by: Niklas Aronsson <niklasar@axis.com >
2022-06-16 22:27:39 +02:00
33bea6d4a1
Update docs link to current techdocs-cli
...
Signed-off-by: Raffi Tamizian <r.tamizian@gmail.com >
2022-06-10 12:32:31 +01:00
7d96a85399
Merge pull request #11593 from backstage/roadmap-updates
...
roadmap-updates
2022-05-26 17:48:41 +02:00
75d8a17466
format with prettier
...
Signed-off-by: Johan Haals <johan.haals@gmail.com >
2022-05-20 10:46:08 +02:00
9199bc5945
roadmap-updates
...
Signed-off-by: <65337273+garyniemen@users.noreply.github.com >
Signed-off-by: Johan Haals <johan.haals@gmail.com >
2022-05-20 10:45:46 +02:00
6377a44efb
1.2 release is out, removing disclaimer
...
Signed-off-by: David Giacomo <dgiacomo@gmail.com >
2022-05-18 16:43:04 -07:00
10d86dedc0
refactor(techdocs): apply review suggestions
...
Signed-off-by: Camila Belo <camilaibs@gmail.com >
2022-05-16 16:18:39 +02:00
9add676fbb
docs(techdocs): add-ons getting started
...
Signed-off-by: Camila Belo <camilaibs@gmail.com >
2022-05-16 16:17:07 +02:00
1904b9c9cc
prettier
...
Signed-off-by: Anders Näsman <andersn@spotify.com >
2022-05-16 09:13:13 +02:00
1e186be521
add addon to available addons table
...
Signed-off-by: Anders Näsman <andersn@spotify.com >
2022-05-16 09:13:12 +02:00
c2a1d8935e
Use @spotify/techdocs v1.0.3 by default.
...
Signed-off-by: Eric Peterson <ericpeterson@spotify.com >
2022-05-11 09:41:54 +02:00
0bd6184a62
Merge pull request #11041 from backstage/Update-TechDocs-Roadmap
...
Update TechDocs roadmap
2022-05-10 09:53:41 +02:00
6225350f24
Update TechDocs roadmap
...
Signed-off-by: Gary Niemen <65337273+garyniemen@users.noreply.github.com >
2022-05-09 15:06:54 +02:00
3711bc6031
feat(techdocs): create text size addon
...
Signed-off-by: Camila Belo <camilaibs@gmail.com >
2022-05-07 11:01:31 +02:00
9e0a6ef4fa
feat(techdocs): add addon settings location
...
Signed-off-by: Camila Belo <camilaibs@gmail.com >
2022-05-06 08:52:54 +02:00
89bb53685c
vale: prune accepted vocabulary
...
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com >
2022-04-27 18:44:55 +02:00
64889b7706
Add an illustration of Addon locations.
...
Signed-off-by: Eric Peterson <ericpeterson@spotify.com >
2022-04-27 15:46:39 +02:00
2f0c7b3ed5
Initial documentation for TechDocs Addons.
...
Signed-off-by: Eric Peterson <ericpeterson@spotify.com >
2022-04-27 12:53:14 +02:00
9fa68705bf
Update default TechDocs container to v1.0.2
...
Signed-off-by: Eric Peterson <ericpeterson@spotify.com >
2022-04-19 13:26:26 +02:00
ee60ad9ea4
Do not require double-nesting of custom TechDocs readers.
...
Signed-off-by: Eric Peterson <ericpeterson@spotify.com >
2022-04-15 16:41:28 +02:00
3a146bb50d
add techdocs-react to tech stack section
...
Signed-off-by: Emma Indal <emma.indahl@gmail.com >
2022-04-15 09:20:34 +02:00
290ef5d8ff
update how to customize reader page documentation
...
Signed-off-by: Emma Indal <emma.indahl@gmail.com >
2022-04-15 09:20:34 +02:00
06bbaf96df
Merge pull request #10578 from backstage/techdocs-roadmap-update
...
Update TechDocs roadmap page
2022-04-07 10:41:10 +02:00
1b44c18d29
Prettier
...
Signed-off-by: Eric Peterson <ericpeterson@spotify.com >
2022-04-07 10:27:49 +02:00
49280ffc33
Update TechDocs roadmap page
...
Signed-off-by: Gary Niemen <65337273+garyniemen@users.noreply.github.com >
2022-04-07 10:27:12 +02:00
efe33862b4
Merge pull request #10403 from carlo-colombo/master
...
[TechDocs] Adds a flag to the cli to override the entrypoint of a custom docker image. It could be used to reuse existing images with different entrypoints.
2022-04-06 09:34:35 +02:00
eb470ea54c
Adds a flag to the cli to override the entrypoint of a custom docker image. It could be used to reuse existing images with different eentrypoints.
...
Signed-off-by: Carlo Colombo <carlo.colombo@klarna.com >
2022-04-06 08:49:32 +02:00
bcf1a2496c
Nest config under mkdocs key.
...
Signed-off-by: Eric Peterson <ericpeterson@spotify.com >
2022-04-05 17:33:18 +02:00
9ab9ce617e
fix(techdocs): do not copy docs/README.md as docs/index.md
...
Signed-off-by: Phil Kuang <pkuang@factset.com >
2022-04-04 12:57:38 -04:00
22bd2bead1
[ #10459 ] 📝 Update documentation to use yarn --cwd arg
...
Signed-off-by: LvffY <louberger@hotmail.fr >
2022-03-29 21:59:53 +02:00
6f2b6a804a
fixups
...
Signed-off-by: Emma Indal <emma.indahl@gmail.com >
2022-03-17 10:16:36 +01:00
be260c99ab
remove deprecated config documentation
...
Signed-off-by: Emma Indal <emma.indahl@gmail.com >
2022-03-17 10:14:57 +01:00
d50fbeddc1
update roadmap docs
...
Signed-off-by: Emma Indal <emma.indahl@gmail.com >
2022-03-17 10:14:36 +01:00
7cb5788e9c
clean up deprecations of techdocs plugin
...
Signed-off-by: Emma Indal <emma.indahl@gmail.com >
2022-03-14 22:39:17 +01:00
869a775f26
Update TechDocs getting started to match create-app.
...
Closes #10133 .
Signed-off-by: Kyle Smith <kyle.smith@salsify.com >
2022-03-14 13:14:51 +01:00
89c7e47967
make the backend plugin ts files consistent
...
Signed-off-by: Fredrik Adelöw <freben@gmail.com >
2022-03-13 19:27:46 +01:00
91bf1e6c1a
Use @backstage/plugin-techdocs-node instead of @backstage/techdocs-common
...
Signed-off-by: Eric Peterson <ericpeterson@spotify.com >
2022-03-04 09:54:19 +01:00
bf4007da6b
Merge pull request #9556 from RoadieHQ/auto-add-techdocs-core-plugin
...
Auto add techdocs core plugin
2022-03-02 15:42:58 +01:00
44a1a447cc
Fix up links to other pages
...
Signed-off-by: Nikolas Skoufis <nskoufis@seek.com.au >
2022-03-01 19:28:53 +11:00
ff0a16fb1a
Add techdocs-core plugin to techdocs builder automatically
...
Currently users need to modify their mkdocs files to container techdocs-core plugin manually when they want to expose techdocs in Backstage. To have a standardized set of extensions without the need to modify existing files (and possibly pollute alternative/additional mkdocs pipelines) this should be added automatically.
This PR adds a helper function to modify the mkdocs file to contain this plugin if it doesn't exist in the config file.
Co-authored-by: @emmaindal
Signed-off-by: Jussi Hallila <jussi@hallila.com >
2022-03-01 08:20:40 +01:00
55031596f2
Prettify how to
...
Signed-off-by: Nikolas Skoufis <nskoufis@seek.com.au >
2022-03-01 09:26:07 +11:00
0bedff8c9a
Add docs for build strategy stuff
...
Signed-off-by: Nikolas Skoufis <nskoufis@seek.com.au >
2022-02-27 19:11:09 +11:00
209fd128e6
removed all references to the removed SCM-specific location types
...
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com >
2022-02-17 17:46:04 +01:00
d9ac082bef
Update link to moved repository - techdocs-cli ( #9305 )
2022-02-07 22:33:34 +01:00
Eric Peterson