Commit Graph

581 Commits

Author SHA1 Message Date
Patrik Oldsberg 362ea5a728 app,create-app: fix index path redirect
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2021-08-07 14:47:04 +02:00
Oliver Sand abfca5bf9e Move setup instructions from readme to microsite
Signed-off-by: Oliver Sand <oliver.sand@sda-se.com>
2021-08-05 09:37:20 +02:00
Oliver Sand 8de9f3f9d6 Remove duplicate heading from the microsite search pages
Signed-off-by: Oliver Sand <oliver.sand@sda-se.com>
2021-08-05 09:37:20 +02:00
Ben Lambert 4b263e4602 Merge pull request #6635 from tudi2d/catalog-fully-responsive
ContentHeader responsiveness
2021-08-03 19:57:58 +02:00
Ben Lambert 4f3c36bf42 Merge pull request #6569 from RoadieHQ/gh4447-elasticseach-searchengine
Implement ElasticSearch search engine
2021-08-03 19:26:19 +02:00
Jussi Hallila 54e1280b6a * Modify index/alias name handling.
* Change config key name to be all lowercase
* Documentation updates

Signed-off-by: Jussi Hallila <jussi@hallila.com>
2021-08-03 13:07:25 +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
Jussi Hallila d9c13d535b Implement ElasticSearch search engine
* Adding indexing, searching and default translator for ElasticSearch engine
* Modifying default backend to use ES if it is enabled
* Adding configuration schema to configure ElasticSearch 3 different ways
   * Elastic.co hosted solution
   * AWS hosted ElasticSearch Service
   * Custom, using standard ElasticSearch URL and auth info
* Add and modify some of the documentation regarding search

Signed-off-by: Jussi Hallila <jussi@hallila.com>
2021-07-30 14:26:32 +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
Philipp Hugenroth 7b8aa8d0d1 Update documentation & add changeset
Signed-off-by: Philipp Hugenroth <philipph@spotify.com>
2021-07-28 15:21:52 +02:00
Tim Hansen 88f2a786df Remove Python requirement from docs
Signed-off-by: Tim Hansen <timbonicus@gmail.com>
2021-07-21 15:26:06 -06:00
Tim Hansen 249cbfc893 Minor tweaks, button fixes
Signed-off-by: Tim Hansen <timbonicus@gmail.com>
2021-07-19 12:18:29 -06:00
Philipp Hugenroth 69f4782680 Merge branch 'master' into catalog-filter-accordion 2021-07-19 11:11:42 +02:00
Philipp Hugenroth b044fa6f7c Clean up code according to review
Signed-off-by: Philipp Hugenroth <philipph@spotify.com>
2021-07-16 13:19:27 +02:00
Himanshu Mishra c0574e207a docs: remove unnencessary clause about software catalog
Signed-off-by: Himanshu Mishra <himanshu@orkohunter.net>
2021-07-16 12:09: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 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