paulononato/backstage
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity
17,701 Commits 1 Branch 0 Tags
eaca0f53fb4fffb2b10b2eee4532a90f3fe2efee
Commit Graph

226 Commits

Author SHA1 Message Date
Emma Indal 1f73801d05 replace entityId with entityRef 
Signed-off-by: Emma Indal <emma.indahl@gmail.com>
 2021-09-30 12:21:10 +02:00
Emma Indal 89091104a0 update how to guide to cover customize the full reader page 
Signed-off-by: Emma Indal <emma.indahl@gmail.com>
 2021-09-29 19:10:15 +02:00
Emma Indal 37822d0740 add example in how to guide of Header without access to metadata 
Signed-off-by: Emma Indal <emma.indahl@gmail.com>
 2021-09-29 19:10:15 +02:00
Emma Indal 280954b5c0 add how-to guide for how to use a custom header 
Signed-off-by: Emma Indal <emma.indahl@gmail.com>
 2021-09-29 19:10:15 +02:00
Emma Indal 51fb9eb42a fix formatting 
Signed-off-by: Emma Indal <emma.indahl@gmail.com>
 2021-09-24 13:55:37 +02:00
bodilb 659c395eae Update docs/features/techdocs/how-to-guides.md 
Signed-off-by: Bodil Björklund <bodilb@spotify.com>
Signed-off-by: Emma Indal <emma.indahl@gmail.com>
 2021-09-24 13:49:09 +02:00
bodilb 24ecb5414a Update docs/features/techdocs/how-to-guides.md 
Signed-off-by: Bodil Björklund <bodilb@spotify.com>
Signed-off-by: Emma Indal <emma.indahl@gmail.com>
 2021-09-24 13:49:09 +02:00
bodilb 6a63cde923 Update docs/features/techdocs/how-to-guides.md 
Signed-off-by: Bodil Björklund <bodilb@spotify.com>
Signed-off-by: Emma Indal <emma.indahl@gmail.com>
 2021-09-24 13:49:09 +02:00
bodilb d1e0287c83 Update docs/features/techdocs/how-to-guides.md 
Signed-off-by: Bodil Björklund <bodilb@spotify.com>
Signed-off-by: Emma Indal <emma.indahl@gmail.com>
 2021-09-24 13:49:09 +02:00
Emma Indal 5bcd49ae9d Add a how to guide on how to implement your custom techdocs apis 
Signed-off-by: Emma Indal <emma.indahl@gmail.com>
 2021-09-24 13:49:09 +02:00
Emma Indal 2d44dd81d7 Update docs/features/techdocs/README.md 
Signed-off-by: Emma Indal <emma.indahl@gmail.com>

Co-authored-by: Fredrik Adelöw <freben@gmail.com>
Signed-off-by: Emma Indal <emma.indahl@gmail.com>
 2021-09-16 17:06:38 +02:00
Patrik Oldsberg 047d0be7b6 docs: format techdocs readme 
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
 2021-09-16 17:06:38 +02:00
Bodil Björklund 4b1e7e6401 Update README.md 
Add alpha and beta release to roadmap

Signed-off-by: Bodil Björklund <bodilb@spotify.com>
 2021-09-16 17:04:59 +02:00
Eric Peterson 15d0a10c57 Document beta versions of TechDocs ecosystem. 
Signed-off-by: Eric Peterson <ericpeterson@spotify.com>
 2021-08-31 11:59:47 +02:00
Raghunandan Balachandran 15bfed2617 Update README.md (#6977) 
Signed-off-by: Raghunandan <soapraj@gmail.com>
 2021-08-27 12:51:15 +02:00
Mert Can Bilgiç 58452cdb72 OpenStack Swift SDK changed from "pkgcloud" to Trendyol's own OpenStack Swift SDK (#6839) 2021-08-25 22:16:10 +02:00
Eric Peterson 30c0801e96 Merge pull request #6709 from backstage/techdocs-common/case-sensitive-migration 
[TechDocs] Beta!
 2021-08-25 13:06:31 +02:00
Eric Peterson d224604f46 Fix docs typo. 
Co-authored-by: Raghunandan Balachandran <raghunandan@spotify.com>
Signed-off-by: Eric Peterson <ericpeterson@spotify.com>
 2021-08-18 17:56:30 +02:00
Eric Peterson 293a33c852 Minor config update to match the new reality. 
Signed-off-by: Eric Peterson <ericpeterson@spotify.com>
 2021-08-12 18:23:30 +02:00
Eric Peterson 0b79bdc1b8 Clean up docs for beta release. 
Signed-off-by: Eric Peterson <ericpeterson@spotify.com>
 2021-08-12 18:22:31 +02:00
Eric Peterson 52547371fb Merge branch 'master' into techdocs-common/case-sensitive-migration 
Signed-off-by: Eric Peterson <ericpeterson@spotify.com>
 2021-08-12 11:27:43 +02:00
Eric Peterson 0c58dd73d0 Merge pull request #6488 from backstage/feat/techdocs-deleted-pages 
Remove stale TechDocs artifacts after publishing new version
 2021-08-10 18:46:24 +02:00
Eric Peterson 3067f0a0c2 Note OpenStack Swift caveat. 
Signed-off-by: Eric Peterson <ericpeterson@spotify.com>
 2021-08-09 18:37:31 +02:00
Camila Belo 2f4f15846d docs(techdocs-common): add case sentitive migration steps 
Co-authored-by: Eric Peterson <ericpeterson@spotify.com>
Signed-off-by: Camila Belo <camilaibs@gmail.com>
 2021-08-09 12:33:28 +02:00
Eric Peterson bc405be6ed Changeset and docs updates. 
Co-authored-by: Camila Loiola <camilaibs@gmail.com>
Signed-off-by: Eric Peterson <ericpeterson@spotify.com>
 2021-08-03 17:16:42 +02:00
Eric Peterson e013dbb7ac Merge pull request #6639 from backstage/techdocs/ref-follow-ups 
[TechDocs] Remove deprecated preparer support and document ref values
 2021-08-03 09:21:38 +02:00
Himanshu Mishra 11c47adcdd docs/techdocs: Indicate optional configs explicitly 
Signed-off-by: Himanshu Mishra <himanshu@orkohunter.net>
 2021-07-30 12:54:51 +02:00
Eric Peterson f0f4997f96 Document latest recommendations for techdocs-ref annotation 
Signed-off-by: Eric Peterson <ericpeterson@spotify.com>
 2021-07-28 18:41:42 +02:00
Eric Peterson 54c25db339 Merge pull request #6071 from andrewthauer/techdocs-custom-docker 
feat(techdocs-common): add custom docker image support
 2021-07-15 10:39:14 +02:00
Andrew Thauer d5eaab91dd feat(techdocs-common): add custom docker image support 
Signed-off-by: Andrew Thauer <athauer@wealthsimple.com>
 2021-07-13 11:26:17 -04:00
Eric Peterson 567c95284f Move AWS policy docs to documentation page. 
Signed-off-by: Eric Peterson <ericpeterson@spotify.com>
 2021-07-13 13:50:33 +02:00
Crevil b124633526 Document techdocs svg_object limitation 
Currently it is not possible to use the PlantUML format 'svg_object' as this
makes it possible for bad actors to inject malicious content into documentation.

This change documents this limitation under the troubleshooting section of the
techdocs feature.

Signed-off-by: Crevil <bjoern.soerensen@gmail.com>
 2021-07-03 12:04:36 +02:00
Himanshu Mishra d29ac0db3a docs: remove techdocs caching caveat 
This has been fixed, and now the cache is managed using an ETag.

Signed-off-by: Himanshu Mishra <himanshu@orkohunter.net>
 2021-07-01 14:03:20 +02:00
Ben Lambert ffe7759de8 Merge pull request #6049 from backstage/timbonicus/move-installation 
Move `catalog` and `scaffolder` installation instructions to READMEs
 2021-06-17 15:14:07 +02:00
Dorn- ca1b960043 fix: typo in openStackSwift credentials username 
A typo was made inside the credentials used by openStackSwift publisher.
As you can see here: https://github.com/backstage/backstage/blob/master/packages/techdocs-common/src/stages/publish/openStackSwift.ts#L67
or https://github.com/backstage/backstage/blob/master/plugins/techdocs-backend/config.d.ts#L119

Signed-off-by: Flavien Chantelot <flavien.chantelot@corp.ovh.com>
Signed-off-by: Flavien Chantelot <flavien.chantelot@ovhcloud.com>
 2021-06-17 09:09:21 +02:00
Tim Hansen 785a42f802 Move installation instructions to READMEs 
Signed-off-by: Tim Hansen <timbonicus@gmail.com>
 2021-06-15 15:00:15 -06:00
Fredrik Adelöw e71d0002ab fix prettier 
Signed-off-by: Fredrik Adelöw <freben@gmail.com>
 2021-06-09 14:51:28 +02:00
Alin Stefan Olaru cd2a47bf2e docs: added example dockerfiles for techdocs and templating 
Signed-off-by: Alin Stefan Olaru <alin.stefan.olaru@lego.com>
 2021-06-04 19:03:19 +02:00
Dominik Henneke 42f2adadc8 Merge pull request #5415 from SDA-SE/feat/rundocker-api 
Refactor the runDockerContainer function to a ContainerRunnerApi interface
 2021-05-05 12:00:40 +02:00
Marco Crivellaro c199090e31 adding steps to enable plantuml support in github workflow 
Signed-off-by: Marco Crivellaro <marco.crive@gmail.com>
 2021-05-04 12:03:52 +01:00
Dominik Henneke e0bfd3d448 Refactor the runDockerContainer function to a ContainerRunner interface. 
Signed-off-by: Dominik Henneke <dominik.henneke@sda-se.com>
 2021-05-03 14:16:28 +02:00
Fredrik Adelöw b99ac3f6e1 Minor composability etc docs changes 
Signed-off-by: Fredrik Adelöw <freben@gmail.com>
 2021-05-02 22:13:05 +02:00
Jussi Hallila e9e56b01ac Add possibility to use path style discovery on S3 tech docs. Enables the possibility to support S3-like buckets that rely on path style API like Localstack. 
Signed-off-by: Jussi Hallila <jussi@hallila.com>
 2021-04-29 10:54:42 +02:00
Patrik Oldsberg 61fdfd70a3 Merge pull request #5353 from backstage/rugvip/plugins-docs 
docs,READMEs: updates for composability changes
 2021-04-27 17:47:13 +02:00
Patrik Oldsberg 74f74ccbdb Apply suggestions from code review 
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>

Co-authored-by: Fredrik Adelöw <freben@gmail.com>
 2021-04-27 17:16:16 +02:00
Patrik Oldsberg df897a6126 Merge pull request #4918 from JacobValdemar/patch-1 
Contribute terraform file for S3 storage in Techdocs
 2021-04-27 10:30:43 +02:00
Eric Peterson 74a5b00eb6 Merge pull request #5371 from adrianke77/techdocs-landing-page-customization 
Add TechDocs landing page customization and exported components
 2021-04-23 11:50:15 +02:00
Chongyang Adrian, Ke 813a4a04f5 fix DocsTable rendering of EmptyState 
Signed-off-by: Chongyang Adrian, Ke <ftt.adrian.ke@grabtaxi.com>
 2021-04-23 11:38:09 +08:00
Adrian Ke Chongyang 7a3b3b2be6 Update docs/features/techdocs/how-to-guides.md 
Signed-off-by: Eric Peterson <ericpeterson@spotify.com>

Co-authored-by: Eric Peterson <iamEAP@users.noreply.github.com>
Signed-off-by: Chongyang Adrian, Ke <ftt.adrian.ke@grabtaxi.com>
 2021-04-23 11:07:18 +08:00
Adrian Ke Chongyang f5dab83b59 Update docs/features/techdocs/how-to-guides.md 
Signed-off-by: Eric Peterson <ericpeterson@spotify.com>

Co-authored-by: Eric Peterson <iamEAP@users.noreply.github.com>
Signed-off-by: Chongyang Adrian, Ke <ftt.adrian.ke@grabtaxi.com>
 2021-04-23 11:07:18 +08:00