Commit Graph

565 Commits

Author SHA1 Message Date
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 Shirley 8e38300d7c Consistently use job-full-name not name or slug
Signed-off-by: Andrew Shirley <andrew.shirley@sainsburys.co.uk>
Signed-off-by: blam <ben@blam.sh>
2021-07-14 20:46:01 +02:00
Andrew Shirley 7991581e62 Use correct annotation name
Signed-off-by: Andrew Shirley <andrew.shirley@sainsburys.co.uk>
Signed-off-by: blam <ben@blam.sh>
2021-07-14 20:46:01 +02:00
Andrew Shirley 66ebdb34d1 Update site documentation
Signed-off-by: Andrew Shirley <andrew.shirley@sainsburys.co.uk>
Signed-off-by: blam <ben@blam.sh>
2021-07-14 20:46:01 +02:00
Ben Lambert 12a62ea5f6 Merge pull request #6423 from chicoribas/Mask-or-hide-values-on-Scaffolder-Review-Step
Mask or hide values on scaffolder review step
2021-07-14 18:25:03 +02:00
chicoribas 6b23a6052f Prettier
Signed-off-by: chicoribas <chico.bribas@gmail.com>
2021-07-13 21:23:02 -03: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
Francisco Ribas c76502dc93 Update docs/features/software-templates/writing-templates.md
Spelling fix

Co-authored-by: Andrea Falzetti <andreafalzetti@users.noreply.github.com>
Signed-off-by: chicoribas <chico.bribas@gmail.com>
2021-07-12 11:29:52 -03:00
Mike Lewis e156990a70 docs(scaffolder): update custom actions docs with new options for createRouter
Signed-off-by: Mike Lewis <mtlewis@users.noreply.github.com>
2021-07-12 12:30:37 +01:00
chicoribas d2e4012f45 Change ui:options to ui:backstage
Signed-off-by: chicoribas <chico.bribas@gmail.com>
2021-07-09 14:34:33 -03:00
chicoribas 4f9eeacc71 Documentation
Signed-off-by: chicoribas <chico.bribas@gmail.com>
2021-07-09 11:42:18 -03:00
Emma Indal cecfe5c7f5 [Search] docs updates (#6402)
* add link to collator implementation to search docs

Signed-off-by: Emma Indal <emma.indahl@gmail.com>

* clean up types from registering new collators  as its now a attribute of the collator itself

Signed-off-by: Emma Indal <emma.indahl@gmail.com>

* one more

Signed-off-by: Emma Indal <emma.indahl@gmail.com>
2021-07-09 09:35:16 +02:00
Mike Lewis b2db928644 scaffolder: improve fetch:template migration docs
Signed-off-by: Mike Lewis <mtlewis@users.noreply.github.com>
2021-07-07 13:17:39 +01:00
Mike Lewis 3ee0caf82e scaffolder: add example diff in fetch:template migration docs
Signed-off-by: Mike Lewis <mtlewis@users.noreply.github.com>
2021-07-07 13:13:25 +01:00
Mike Lewis fdac00fb3f scaffolder: fix typo in fetch:template migration docs
Signed-off-by: Mike Lewis <mtlewis@users.noreply.github.com>
2021-07-07 13:10:36 +01:00
Mike Lewis 56b61c2bc0 scaffolder: prefix input values in fetch:template templates
Signed-off-by: Mike Lewis <mtlewis@users.noreply.github.com>
2021-07-07 11:26:00 +01:00
Mike Lewis 9d759702b1 docs: update docs to refer to new fetch:template action
Signed-off-by: Mike Lewis <mtlewis@users.noreply.github.com>
2021-07-06 15:07:37 +01: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
Fredrik Adelöw 4666577b53 Merge pull request #6141 from backstage/software-catalog-rename
Docs: Update references to "service catalog"
2021-06-28 13:47:16 +02:00
Patrik Oldsberg 642cec7ac7 docs: remove references to @backstage/core
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2021-06-24 12:50:40 +02:00
Joe Porpeglia 709589a839 Rename service catalog to software catalog, excluding blog posts
Signed-off-by: Joe Porpeglia <josephp@spotify.com>
2021-06-21 11:48:43 -04: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
Eric Peterson ce5b76ddca Merge pull request #5715 from backstage/mob/document-search-v1
[Search] WIP documentation for the V1 Search Milestone
2021-06-09 19:22:24 +02:00
Eric Peterson 5c9c34dee9 Merge pull request #5927 from backstage/iameap/search-alpha-release
[Search] Initial, Alpha Release
2021-06-09 19:21:15 +02:00
Fredrik Adelöw 363b0b87ea Merge pull request #5925 from xShteff/master
docs: added example dockerfiles for techdocs and templating
2021-06-09 15:37:25 +02:00
Fredrik Adelöw e71d0002ab fix prettier
Signed-off-by: Fredrik Adelöw <freben@gmail.com>
2021-06-09 14:51:28 +02:00
Fredrik Adelöw 28fc26ddf4 Merge pull request #5849 from SDA-SE/feat/scaffolder-conditional
Conditional scaffolder steps
2021-06-08 14:25:49 +02:00
Emma Indal f3a9a063a6 docs fixups
Signed-off-by: Emma Indal <emma.indahl@gmail.com>
2021-06-06 22:04:29 +02:00
Emma Indal 50873903fb Add Lunr as example
Signed-off-by: Emma Indal <emma.indahl@gmail.com>
2021-06-06 22:02:09 +02:00
Eric Peterson 3bc581732c More iteration on Search Feature documentation.
Signed-off-by: Eric Peterson <ericpeterson@spotify.com>
2021-06-06 12:52:43 +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
Eric Peterson d2a75ce613 v1/v2/v3 -> alpha/beta/ga
Signed-off-by: Eric Peterson <ericpeterson@spotify.com>
2021-06-04 18:40:46 +02:00
Oliver Sand 09fdc24802 Improve documentation
Signed-off-by: Oliver Sand <oliver.sand@sda-se.com>
2021-06-04 16:30:33 +02:00
Oliver Sand af06c6a782 Some small fixes
Signed-off-by: Oliver Sand <oliver.sand@sda-se.com>
2021-06-04 16:30:32 +02:00
anovis 047658256e prettify
Signed-off-by: anovis <anovis@ymail.com>
2021-06-03 13:30:13 -04:00
Austen 5292d453b4 Update docs/features/software-templates/writing-templates.md
Co-authored-by: Ben Lambert <ben@blam.sh>
Signed-off-by: anovis <anovis@ymail.com>
2021-06-03 09:08:14 -04:00
anovis f20a6547bd update based on comments
Signed-off-by: anovis <anovis@ymail.com>
2021-06-02 11:25:56 -04:00
anovis 3dacab3c9b fix syntax error
Signed-off-by: anovis <anovis@ymail.com>
2021-06-02 10:42:12 -04:00
anovis 1c4b39ebf7 adding example for arrays
Signed-off-by: anovis <anovis@ymail.com>
2021-06-02 10:42:12 -04:00
Tim Hansen 187180db5c Improve catalog-customization doc
Signed-off-by: Tim Hansen <timbonicus@gmail.com>
2021-05-26 21:32:19 -06:00
Tim Hansen 9768e36c4e Merge branch 'master' into timbonicus/catalog-entity-context 2021-05-26 17:21:23 -06:00
Tim Hansen 0ddb9719f0 Add warning
Signed-off-by: Tim Hansen <timbonicus@gmail.com>
2021-05-26 13:37:02 -06:00
Tim Hansen e2d5014c71 Add documentation for catalog customization
Signed-off-by: Tim Hansen <timbonicus@gmail.com>
2021-05-26 12:38:30 -06:00
Oliver Sand b517c7f9b7 Remove indention
Signed-off-by: Oliver Sand <oliver.sand@sda-se.com>
2021-05-26 14:17:36 +02:00
Oliver Sand 35e73aab14 Fix wrong yaml indention in docs
Signed-off-by: Oliver Sand <oliver.sand@sda-se.com>
2021-05-26 14:10:23 +02:00
Fredrik Adelöw aef9fb2399 Implement suggested changes after discussions
Signed-off-by: Fredrik Adelöw <freben@gmail.com>
2021-05-24 19:13:30 +02:00