paulononato/backstage
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
25,068 Commits 1 Branch 0 Tags
4bfde894e0891efdbf0ba61264159f971286e6fb
Commit Graph

270 Commits

Author SHA1 Message Date
LvffY 22bd2bead1 [#10459] 📝 Update documentation to use yarn --cwd arg 
Signed-off-by: LvffY <louberger@hotmail.fr>
 2022-03-29 21:59:53 +02:00
Emma Indal 6f2b6a804a fixups 
Signed-off-by: Emma Indal <emma.indahl@gmail.com>
 2022-03-17 10:16:36 +01:00
Emma Indal be260c99ab remove deprecated config documentation 
Signed-off-by: Emma Indal <emma.indahl@gmail.com>
 2022-03-17 10:14:57 +01:00
Emma Indal d50fbeddc1 update roadmap docs 
Signed-off-by: Emma Indal <emma.indahl@gmail.com>
 2022-03-17 10:14:36 +01:00
Emma Indal 7cb5788e9c clean up deprecations of techdocs plugin 
Signed-off-by: Emma Indal <emma.indahl@gmail.com>
 2022-03-14 22:39:17 +01:00
Kyle Smith 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
Fredrik Adelöw 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
Eric Peterson 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
Emma Indal 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
Nikolas Skoufis 44a1a447cc Fix up links to other pages 
Signed-off-by: Nikolas Skoufis <nskoufis@seek.com.au>
 2022-03-01 19:28:53 +11:00
Jussi Hallila 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
Nikolas Skoufis 55031596f2 Prettify how to 
Signed-off-by: Nikolas Skoufis <nskoufis@seek.com.au>
 2022-03-01 09:26:07 +11:00
Nikolas Skoufis 0bedff8c9a Add docs for build strategy stuff 
Signed-off-by: Nikolas Skoufis <nskoufis@seek.com.au>
 2022-02-27 19:11:09 +11:00
Patrik Oldsberg 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
Jahred Hope d9ac082bef Update link to moved repository - techdocs-cli (#9305) 2022-02-07 22:33:34 +01:00
Eric Peterson 912b2d9925 Note default ServerURL config in kroki how-to 
Signed-off-by: Eric Peterson <ericpeterson@spotify.com>
 2022-01-28 10:45:59 +01:00
Patrik Oldsberg efe02b86ff docs: tweak line wrapping of doc action 
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
 2022-01-26 14:35:06 +01:00
Patrik Oldsberg 4cad73ca7f run prettier 
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
 2022-01-26 12:02:06 +01:00
Fredrik Adelöw 5390c64d87 Merge pull request #8804 from lakshikaparihar/master 
Adding Mermaid instructions to Tech Docs Guides
 2022-01-19 16:13:45 +01:00
Fredrik Adelöw 9565610509 prettier 
Signed-off-by: Fredrik Adelöw <freben@gmail.com>
 2022-01-19 15:48:34 +01:00
Eric Peterson 47277c0d8c Bump @spotify/techdocs container to v0.3.6 
Signed-off-by: Eric Peterson <ericpeterson@spotify.com>
 2022-01-17 17:34:01 +01:00
lakshikaparihar ab2ae2a28c formatted code with prettier 
Signed-off-by: lakshikaparihar <pariharlakshika@gmail.com>
 2022-01-11 13:27:33 +05:30
lakshikaparihar 0988d56b69 formatted md file 
Signed-off-by: lakshikaparihar <pariharlakshika@gmail.com>
 2022-01-11 12:37:17 +05:30
Lakshika Parihar db75552b8b Update how-to-guides.md 
Signed-off-by: lakshikaparihar <pariharlakshika@gmail.com>
 2022-01-07 22:29:34 +05:30
Eric Peterson 3f975582a4 Merge pull request #8625 from dweber019/patch-1 
Fix mkdocs-techdocs-core version
 2022-01-07 11:50:26 +01:00
David Weber a46fe68c1c Update to mkdocs-techdocs-core==0.2.2 
Signed-off-by: David Weber <david.weber@baloise.ch>
 2022-01-07 08:08:54 +01:00
Greg Taylor d6aec1c506 Fix techdocs links to the CLI (#8650) 
The techdocs docs were written prior to the techdocs-cli being
crunched into the monorepo. This commit fixes a few links that
still point to the old separte spotify/techdocs-cli repo.

Signed-off-by: Greg Taylor <snagglepants@gmail.com>
 2021-12-28 08:59:11 +01:00
Denis Aoki aa8f764a3e techdocs(sanitizer): adds iframe support (#8237) 
Signed-off-by: dnsaoki2 <dnsaoki@gmail.com>
 2021-12-27 12:01:22 +01:00
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