paulononato/backstage
1
0
Fork 0
Code Issues Pull Requests Actions 3 Packages Projects Releases Wiki Activity
20,188 Commits 1 Branch 0 Tags
1e49c23eb74ff853677872165a61ba7c5fd58f12
Commit Graph

242 Commits

Author SHA1 Message Date
Emma Indal aa7a73e947 [TechDocs] Add metadata to cli docs (#8445) 
Signed-off-by: Emma Indal <emma.indahl@gmail.com>
 2021-12-10 10:12:13 +01:00
Eric Peterson e3e6e9a86d One last docs update to clarify new architecture. 
Signed-off-by: Eric Peterson <i.am@eric.pe>
 2021-12-05 17:05:07 -06:00
Eric Peterson ef04b09f75 Make cache readTimeout configurable. 
Signed-off-by: Eric Peterson <ericpeterson@spotify.com>
 2021-11-28 13:16:04 -07:00
Eric Peterson 0a5278b92a Update Backstage.io docs with config/recs 
Signed-off-by: Eric Peterson <ericpeterson@spotify.com>
 2021-11-28 13:16:04 -07:00
Otto Sichert b23bc7f9c3 Change default port of backend to 7007 due to MacOS Control Center update 
Signed-off-by: Otto Sichert <git@ottosichert.de>
 2021-11-18 16:45:57 +01:00
Eric Peterson ec2c835afc Merge pull request #8007 from backstage/refactor/merge-back-techdocs-cli 
Tech Docs Command Line Reunification
 2021-11-17 13:00:48 +01:00
therynamo 9e64a7ac1e pr suggestions 
Signed-off-by: therynamo <theryn.groetken@gemini.com>
 2021-11-15 10:56:54 -06:00
therynamo 7acc18e21a feat: Allow SSE on AWS S3 Buckets 
Signed-off-by: therynamo <theryn.groetken@gemini.com>
 2021-11-15 10:56:13 -06:00
Andrew Thauer 71e7b0ee92 refactor: reunification of techdocs-cli and backstage repos 
Signed-off-by: Andrew Thauer <athauer@wealthsimple.com>
 2021-11-11 19:31:55 +01:00
Eric Peterson d066399739 Merge pull request #7554 from cmpadden/techdocs-storage-subfolder 
Support optional bucketRootPath in GCS and S3 techdocs publishers
 2021-10-25 15:34:10 +02:00
Patrik Oldsberg 4552206702 Merge pull request #7657 from SDA-SE/feat/techdocs-grid 
Add `<EntityListDocsGrid>` and extend `<DocsCardGrid>` to display the entity title
 2021-10-21 00:35:19 +02:00
Oliver Sand bf9d10ba5f Mention in the docs 
Signed-off-by: Oliver Sand <oliver.sand@sda-se.com>
 2021-10-20 16:45:19 +02:00
Fidel Coria af64518bbe fix typo in techdocs documentation (#7677) 
* fix typo

Signed-off-by: Fidel Coria <fidel.coria@aa.com>

* fix another typo

Signed-off-by: Fidel Coria <fidel.coria@aa.com>

* fix tiny typo

Signed-off-by: Fidel Coria <fidel.coria@aa.com>
 2021-10-19 16:50:38 +02:00
Emma Indal 6c49901f6e [TechDocs] fix link to how-to guide (#7673) 
Signed-off-by: Emma Indal <emma.indahl@gmail.com>
 2021-10-19 13:31:03 +02:00
Emma Indal 405dbc80e7 [Techdocs] Improve create publish docs (#7626) 2021-10-18 18:19:38 +02:00
Colton Padden d207f6ee9e Support optional bucketRootPath in GCS and S3 techdocs publishers 
- Updated app-config.yaml with additional configuration parameters:
    - techdocs.publisher.awsS3.bucketRootPath
    - techdocs.publisher.googleGcs.bucketRootPath
- Updated `fromConfig` and constructors to support additional `bucketRootPath`
  parameters.
- Updated publish method to support `bucketRootPath` in constructing destination
  file path
- Updated `fetchTechDocsMetadata` to use `bucketRootPath`
- Updated `docsRouter` to use `docsRouter` when retrieving files
    - When using both legacy casing, and a bucket root path, additional logic
      was added to prevent the root path's case from being modified as
      previously legacy casing would be applied to the first three entities of
      the URI
- Updated `hasDocsBeenGenerated` to use `bucketRootPath`
- Added additional unit tests for new configurations to updated, and new methods

Signed-off-by: Colton Padden <colton.padden@fastmail.com>
 2021-10-11 10:49:40 -04:00
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