Commit Graph

957 Commits

Author SHA1 Message Date
Jonah Back fe5a25ecab address review comments
Signed-off-by: Jonah Back <jonah@jonahback.com>
2022-07-10 20:14:29 -07:00
Jonah Back 6821bbb122 Merge branch 'master' into feature/EKSCatalog
Signed-off-by: Jonah Back <jonah@jonahback.com>
2022-07-10 20:12:09 -07:00
Eric Peterson 8d0836b08c Merge pull request #12434 from backstage/emmaindal/search-collator-tutorial
[Search] add tutorial for creating a collator
2022-07-08 18:19:56 +02:00
Eric Peterson 31dc1a7c10 Merge pull request #12169 from anicke/techdocs-gerrit-provider
Docs/techdocs: Add gerrit as supported provider
2022-07-08 18:05:53 +02:00
Patrik Oldsberg 84529131ff docs: update catalog docs to point to catalog-node
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2022-07-08 14:06:09 +02:00
Matthew Clarke f5c9730639 (feat): easier Kubernetes local development steps (#12373)
* (feat): easier kubernetes local deevlopment steps

Signed-off-by: Matthew Clarke <mclarke@spotify.com>

* add changeset

Signed-off-by: Matthew Clarke <mclarke@spotify.com>

* update api docs

Signed-off-by: Matthew Clarke <mclarke@spotify.com>

* fix typo

Signed-off-by: Matthew Clarke <mclarke@spotify.com>
2022-07-07 09:45:25 +02:00
Patrik Oldsberg 87fdedfc97 Merge pull request #12344 from immobiliare/feat/added-sentry-organization-annotation
feat(sentry): added annotation to specify organization per compoment
2022-07-06 15:55:13 +02:00
Antonio Musolino 1b7c691a3b feat(sentry): added possibility to specify organization per component
Signed-off-by: Antonio Musolino <antoniomusolino007@gmail.com>
2022-07-06 15:39:58 +02:00
Jonah Back 621fa1e5a8 Merge branch 'master' into feature/EKSCatalog
Signed-off-by: Jonah Back <jonah@jonahback.com>
2022-07-05 10:26:32 -07:00
Emma Indal 31b391d8dd add link from search how to guides to integrating search into plugins tutorials
Signed-off-by: Emma Indal <emma.indahl@gmail.com>
2022-07-05 12:23:19 +02:00
Andre Wanlin e52f7801b0 Adjustments based on feedback
Signed-off-by: Andre Wanlin <67169551+awanlin@users.noreply.github.com>
2022-06-30 15:27:32 +02:00
Ben Lambert 5a98712ce3 Merge pull request #11806 from dotressel/add-allowed-repos-to-repourlpicker
Scaffolder: RepoUrlPicker: Add allowedRepos Option and move RepoName Input to own Component
2022-06-29 16:00:06 +02:00
Eric Peterson 697e899396 Merge pull request #12305 from Niksko/techdocs-cache-docs
Explain how to enable techdocs cache
2022-06-29 15:07:16 +02:00
Ben Lambert 858390e571 Merge pull request #12197 from awanlin/topic/add-addon-package-install
Added details about installing addons package
2022-06-29 13:57:44 +02:00
Ben Lambert dd2af0e1b0 Merge pull request #12111 from VladMasarik/docs-tempalte
Docs update custom template actions
2022-06-29 11:16:24 +02:00
Ben Lambert 8759ae7957 Merge pull request #12301 from pschilli/docs-feat-sc-config-readonly
Update documentation of catalog readonly mode
2022-06-29 10:03:06 +02:00
Nikolas Skoufis 79639013b5 Explain how to enable techdocs cache
For dummies like me, it took me a while to figure out that even if you
have configured the backend cache, the TechDocs cache is not enabled
until you set a value for the TTL. My interpretation was that it was
just configured by default, and the fact that a default value for ttl
seems to appear here points to that as well.

This change hopes to make this explicit, to avoid others spinning their
wheels like I have.

Signed-off-by: Nikolas Skoufis <nskoufis@seek.com.au>
2022-06-29 17:38:41 +10:00
Patrick Schilling b548fb7782 Update documentation of readonly mode to clarify what functionality is disallowed
Signed-off-by: Patrick Schilling <pschilli@gmail.com>
2022-06-28 14:28:08 -05:00
Eric Peterson c5af773757 Note the (technically) breaking change and update docs.
Signed-off-by: Eric Peterson <ericpeterson@spotify.com>
2022-06-27 13:50:44 +02:00
Jonah Back 7162fb9068 address review comments
Signed-off-by: Jonah Back <jonah@jonahback.com>
2022-06-26 13:40:07 -07:00
Jonah Back 38bdd58f0a Merge branch 'master' into feature/EKSCatalog
Signed-off-by: Jonah Back <jonah@jonahback.com>
2022-06-26 13:37:37 -07:00
Andre Wanlin e271183fe7 Added example for custom reader page
Signed-off-by: Andre Wanlin <67169551+awanlin@users.noreply.github.com>
2022-06-23 10:54:24 -05:00
Camila Belo f9e2ec2551 Merge pull request #11065 from anicke/techdocs-staticdir
[TechDocs] Added configuration for local publishing target
2022-06-23 16:54:42 +02:00
Andre Wanlin dabbb286f7 Corrected typos
Signed-off-by: Andre Wanlin <67169551+awanlin@users.noreply.github.com>
2022-06-22 06:58:23 -05:00
Andre Wanlin 2b74a85059 Added details about installing addons package
Signed-off-by: Andre Wanlin <67169551+awanlin@users.noreply.github.com>
2022-06-21 17:42:31 -05:00
Niklas Aronsson 04c958d458 Docs/techdocs: Add gerrit as supported provider
Signed-off-by: Niklas Aronsson <niklasar@axis.com>
2022-06-21 07:24:57 +02:00
Jonah Back 953e2e356d Merge branch 'master' into feature/EKSCatalog
Signed-off-by: Jonah Back <jonah@jonahback.com>
2022-06-20 14:58:13 -07:00
Jonah Back cb86da6467 feat: add test and basic docs for catalog cluster locator
Signed-off-by: Jonah Back <jonah@jonahback.com>
2022-06-20 14:34:20 -07:00
Vladimir Masarik fccddd80fd docs: fix prettier complaints
Signed-off-by: Vladimir Masarik <vladimir.masarik@ef.com>
2022-06-20 17:43:44 +02:00
Vladimir Masarik e81be86682 docs: fix template typos
Signed-off-by: Vladimir Masarik <vladimir.masarik@ef.com>
2022-06-17 16:02:15 +02:00
Vladimir Masarik a6321c9b9f docs: writing templates, add examples of how to use values
Add information on how to actually use the parameters from the UI in the actual code
so that users can fully utilize the templating power of the default templating
action.

Signed-off-by: Vladimir Masarik <vladimir.masarik@ef.com>
2022-06-17 15:25:17 +02:00
Vladimir Masarik 7fc1f50f57 docs: Adding templates, added note for users that they need to refresh the location
Othwise, backstage won't display the updated or newly added template,
and it won't report any errors either.

Signed-off-by: Vladimir Masarik <vladimir.masarik@ef.com>
2022-06-17 15:24:46 +02:00
Vladimir Masarik 4ae8c4b0b7 docs: Adding templates, add template as a file example
Signed-off-by: Vladimir Masarik <vladimir.masarik@ef.com>
2022-06-17 14:49:43 +02:00
Vladimir Masarik 1ee1a02d67 docs: custom template actions update code exmaple
Users don't need the container runner, and variables have to
be passed in differently

Signed-off-by: Vladimir Masarik <vladimir.masarik@ef.com>
2022-06-17 14:40:22 +02:00
Vladimir Masarik 7e35d62a13 docs: custom tempalte actions clearly express that the builtin actions are replaced
Signed-off-by: Vladimir Masarik <vladimir.masarik@ef.com>
2022-06-17 14:40:22 +02:00
Johan Haals 8f94993061 Merge pull request #12021 from dotressel/improve-docs-for-scmauthapi
docs: scaffolder: improve docs to setup the RepoUrlPicker authentication feature
2022-06-17 10:26:57 +02:00
Niklas Aronsson 860765ff45 [TechDocs] Added configuration for local publishing target
This patch adds a configuration option for setting the "local"
techdocs target directory. The target directory can be set using
the "techdocs.publisher.local.publishDirectory".

This fixes two "TODOs" in the "plugins/techdocs-node/src/stages
/publish/local.ts" file:

*  Use a more persistent storage than node_modules or /tmp directory.
   Make it configurable with techdocs.publisher.local.publishDirectory
*  Move the logic of setting staticDocsDir based on config over to
   fromConfig, and set the value as a class parameter.

Signed-off-by: Niklas Aronsson <niklasar@axis.com>
2022-06-16 22:27:39 +02:00
Maixmilian Ressel 557072e19b change some capitalizations
Signed-off-by: Maixmilian Ressel <maximiliandotressel@gmail.com>
2022-06-16 12:43:32 +02:00
Maixmilian Ressel 2de3fc3231 Add documentation for allowedOwners and allowedRepos
Signed-off-by: Maixmilian Ressel <maximiliandotressel@gmail.com>
2022-06-15 17:18:44 +02:00
James Russo 279fa6b116 update docs again
Signed-off-by: James Russo <jrusso@brex.com>
2022-06-15 10:46:32 -04:00
James Russo 90fb26a514 update additional files
Signed-off-by: James Russo <jrusso@brex.com>
2022-06-15 10:03:37 -04:00
Maixmilian Ressel 85f2d90543 docs: scaffolder: improve docs to setup the RepoUrlPicker authentication
Signed-off-by: Maixmilian Ressel <maximiliandotressel@gmail.com>
2022-06-14 16:30:24 +02:00
blam 79c8e5c586 chore: added doc updates for user templating
Signed-off-by: blam <ben@blam.sh>
2022-06-13 13:59:46 +02:00
Emma Indal 329b0349aa Merge pull request #11962 from backstage/emmaindal/elasticsearch-search-engine-custom-index-template
[Search - ES module] possibility to set custom index template
2022-06-10 14:32:29 +02:00
Fredrik Adelöw 0d7bbf8b07 Merge pull request #11970 from raffitamizian/Update-docs
Update docs link to current techdocs-cli
2022-06-10 13:44:59 +02:00
Fredrik Adelöw 1d69233618 Merge pull request #11964 from pitwegner/master
Add component dependency in text and diagram
2022-06-10 13:43:35 +02:00
Emma Indal d3edcd0784 add instructions for how to set a custom index template
Signed-off-by: Emma Indal <emma.indahl@gmail.com>
2022-06-10 13:41:56 +02:00
Raffi Tamizian 33bea6d4a1 Update docs link to current techdocs-cli
Signed-off-by: Raffi Tamizian <r.tamizian@gmail.com>
2022-06-10 12:32:31 +01:00
Pit Wegner 2fa8826678 add component dependency in text and diagram
Signed-off-by: pitwegner <pit.wegner@student.hpi.de>
2022-06-10 02:22:56 -07:00
Anders Näsman f28bc28834 update docs
Signed-off-by: Anders Näsman <andersn@spotify.com>
2022-06-10 10:27:57 +02:00