Commit Graph

338 Commits

Author SHA1 Message Date
zjpersc edecccabe4 Updating the feature doc for techdocs-cli
Signed-off-by: zjpersc <zjpersc@gmail.com>
2023-03-10 14:01:24 -06:00
Paul Schultz 34fe6c9246 Merge branch 'master' into update-codeblocks 2023-03-08 10:07:11 -06:00
Patrik Oldsberg e5a9031eae microsite-next: redirects for new index pages + fix links
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2023-03-06 11:46:11 +01:00
Paul Schultz 9c95f91c0a Add titles to codeblocks and switch from diff codeblock to language codeblock
Signed-off-by: Paul Schultz <pschultz@pobox.com>
2023-03-01 13:30:38 -06:00
Jos Craw 8b36144ab0 chore: added docs for overall config
Signed-off-by: Jos Craw <me.joscraw@gmail.com>
2023-02-26 10:47:18 +13:00
Jos Craw cc77729c48 fix: update docs to include updated command reference
Signed-off-by: Jos Craw <me.joscraw@gmail.com>
2023-02-25 08:45:32 +13:00
Johan Haals 7a23cdfa59 Update image links to use markdown syntax
Co-authored-by: Ben Lambert <ben@blam.sh>
Co-authored-by: Fredrik Adelöw <freben@users.noreply.github.com>
Signed-off-by: Johan Haals <johan.haals@gmail.com>
2023-02-21 11:43:14 +01:00
MaeIsBad 00e67af342 Fix spelling mistake in techdocs
Signed-off-by: MaeIsBad <26093674+MaeIsBad@users.noreply.github.com>
2023-02-20 09:51:06 +01:00
Patrik Oldsberg 0debdc983c Merge pull request #16036 from sang-w0o/patch-1
Specify RUN location for installing mkdocs dependencies.
2023-02-08 14:25:13 +01:00
David Weber 4660b63947 feat: add TechDocs addon LightBox
Signed-off-by: David Weber <david.weber@w3tec.ch>
2023-02-06 19:38:19 +01:00
나상우(Roy) db77ab2869 Update version of mkdocs-techdocs-core to most recent version.
Signed-off-by: 나상우(Roy) <robbyra@gmail.com>
2023-01-30 10:58:18 +09:00
나상우(Roy) fcbd3d72fb Speficy RUN location for installing mkdocs dependencies.
Signed-off-by: 나상우(Roy) <robbyra@gmail.com>
2023-01-30 10:47:43 +09:00
lloydchang 96db35f389 docs(using-cloud-storage.md): fix very minor typo
remove extra period

Signed-off-by: lloydchang <lloydchang@gmail.com>
2023-01-29 07:32:36 -08:00
나상우(Roy) 3ea29add12 Add missing finishing single quote.
Signed-off-by: 나상우(Roy) <robbyra@gmail.com>
2023-01-27 17:16:35 +09:00
Morgan Bentell 794a87c36c remove autoformatting changes
Signed-off-by: Morgan Bentell <mbentell@spotify.com>
2023-01-10 09:52:45 +01:00
Morgan Bentell 29113e760a update docs and clean up
Signed-off-by: Morgan Bentell <mbentell@spotify.com>
2023-01-09 10:03:39 +01:00
Morgan Bentell bc18c902a2 clean up and update documentation, changeset and cli-report
Signed-off-by: Morgan Bentell <mbentell@spotify.com>
2023-01-04 15:27:27 +01:00
Johan Haals dbe6b9308d Fix docs for microsite-next
Signed-off-by: Johan Haals <johan.haals@gmail.com>
2022-12-13 14:31:10 +01:00
Clare Liguori e40790d0c2 Use integration-aws-node for credentials in S3 Techdocs
Signed-off-by: Clare Liguori <liguori@amazon.com>
2022-11-28 14:56:13 -08:00
Clare Liguori 0224a98c75 Merge remote-tracking branch 'upstream/master' into upgrade-techdocs-sdk-v3
Signed-off-by: Clare Liguori <liguori@amazon.com>
2022-11-25 11:45:57 -08:00
Fredrik Adelöw d6e10c7bdb add explicit python version
Signed-off-by: Fredrik Adelöw <freben@gmail.com>
2022-11-25 14:23:01 +01:00
Patrik Oldsberg ed13863bd7 Update docs/features/techdocs/configuring-ci-cd.md
Co-authored-by: Anders Näsman <70215212+realandersn@users.noreply.github.com>
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2022-11-21 16:22:53 +01:00
Patrik Oldsberg 93a2a455ed workflows,docs: bump github action versions
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2022-11-21 13:31:50 +01:00
Clare Liguori 37931c33ce TechDocs: upgrade to AWS SDK v3
Signed-off-by: Clare Liguori <liguori@amazon.com>
2022-11-17 21:36:15 -08:00
Anders Näsman 7165a2fcf9 Merge pull request #13913 from axdotl/patch-1
Update to most recent mkdocs-techdocs-core version
2022-10-25 09:33:39 +02:00
Simon Ninon 5691baea69 plugin-techdocs: add group filtering support to EntityListDocsGrid
Signed-off-by: Simon Ninon <sninon@pagerduty.com>
2022-10-24 10:34:57 -07:00
Axel Köhler e806bb0eb6 Update to most recent mkdocs-techdocs-core version
Signed-off-by: Axel Köhler <9337156+axdotl@users.noreply.github.com>
2022-09-29 15:49:29 +02:00
James Turley aa524a5377 Add projectId config option to GCS techdocs publisher
Fixes #13049

Signed-off-by: James Turley <jamesturley@gocardless.com>
2022-08-22 15:47:18 +01:00
Gary Niemen 2977f2473d roadmap_updates-techdocs_search
Signed-off-by: Gary Niemen <65337273+garyniemen@users.noreply.github.com>
2022-08-04 10:57:13 +02:00
Mathias Geat dcbb438e5f feat(techdocs-cli): Allow passing docker extra args to @techdocs/cli serve and serve:mkdocs
Signed-off-by: Mathias Geat <mathias.geat@objectbay.com>
2022-08-01 13:22:01 +02:00
Iswariya Manivannan 658e22b1a8 docs: Remove markdown version constraint for mkdocs-techdocs-core
Signed-off-by: Iswariya Manivannan <iswariya.m17@gmail.com>
2022-07-29 16:51:01 +02:00
Eric Peterson 31dc1a7c10 Merge pull request #12169 from anicke/techdocs-gerrit-provider
Docs/techdocs: Add gerrit as supported provider
2022-07-08 18:05:53 +02:00
Eric Peterson 697e899396 Merge pull request #12305 from Niksko/techdocs-cache-docs
Explain how to enable techdocs cache
2022-06-29 15:07:16 +02:00
Ben Lambert 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
Nikolas Skoufis 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
Andre Wanlin 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
Andre Wanlin dabbb286f7 Corrected typos
Signed-off-by: Andre Wanlin <67169551+awanlin@users.noreply.github.com>
2022-06-22 06:58:23 -05:00
Andre Wanlin 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
Niklas Aronsson 04c958d458 Docs/techdocs: Add gerrit as supported provider
Signed-off-by: Niklas Aronsson <niklasar@axis.com>
2022-06-21 07:24:57 +02:00
Niklas Aronsson 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
Raffi Tamizian 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
Gary Niemen 7d96a85399 Merge pull request #11593 from backstage/roadmap-updates
roadmap-updates
2022-05-26 17:48:41 +02:00
Johan Haals 75d8a17466 format with prettier
Signed-off-by: Johan Haals <johan.haals@gmail.com>
2022-05-20 10:46:08 +02:00
Gary Niemen 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
David Giacomo 6377a44efb 1.2 release is out, removing disclaimer
Signed-off-by: David Giacomo <dgiacomo@gmail.com>
2022-05-18 16:43:04 -07:00
Camila Belo 10d86dedc0 refactor(techdocs): apply review suggestions
Signed-off-by: Camila Belo <camilaibs@gmail.com>
2022-05-16 16:18:39 +02:00
Camila Belo 9add676fbb docs(techdocs): add-ons getting started
Signed-off-by: Camila Belo <camilaibs@gmail.com>
2022-05-16 16:17:07 +02:00
Anders Näsman 1904b9c9cc prettier
Signed-off-by: Anders Näsman <andersn@spotify.com>
2022-05-16 09:13:13 +02:00
Anders Näsman 1e186be521 add addon to available addons table
Signed-off-by: Anders Näsman <andersn@spotify.com>
2022-05-16 09:13:12 +02:00
Eric Peterson 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