Commit Graph

942 Commits

Author SHA1 Message Date
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
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
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
ivgo 296bfcb1fd Fix some typos and other requested changes
Signed-off-by: ivgo <ivgo@spreadgroup.com>
2022-06-07 11:02:56 +02:00
ivgo 09f1256a85 First implementation of vault-plugin
Signed-off-by: ivgo <ivgo@spreadgroup.com>
2022-06-07 11:02:56 +02:00
Patrik Oldsberg b5e056f312 Merge pull request #11603 from goenning/go/refresh-rate-k8s
[Kubernetes Plugin] ability to configure refresh interval on Kubernetes tab
2022-06-03 16:55:23 +02:00
goenning 6c42c12164 update docs
Signed-off-by: goenning <me@goenning.net>
2022-06-02 15:14:19 +01:00
Gary Niemen 7d96a85399 Merge pull request #11593 from backstage/roadmap-updates
roadmap-updates
2022-05-26 17:48:41 +02:00
Johan Haals 75d8a17466 format with prettier
Signed-off-by: Johan Haals <johan.haals@gmail.com>
2022-05-20 10:46:08 +02:00
Gary Niemen 9199bc5945 roadmap-updates
Signed-off-by: <65337273+garyniemen@users.noreply.github.com>
Signed-off-by: Johan Haals <johan.haals@gmail.com>
2022-05-20 10:45:46 +02:00
Patrik Oldsberg 115f6452bf scaffolder: form data fixups
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2022-05-19 17:09:48 +02:00
Johan Haals 35d48df50a Merge pull request #11505 from ivangonzalezacuna/feature/kubernetes-statefulsets
Add support for statefulsets in kubernetes
2022-05-19 14:08:25 +02:00
Johan Haals c29997a0ee Merge pull request #11513 from arhill05/master
Add Git actions to Plugins Marketplace
2022-05-19 14:04:53 +02:00
Johan Haals e2237ddaad Merge pull request #11540 from tritri251214/form-context-scaffolder
[Scaffolder] Get data of other fields in Form from a custom field
2022-05-19 13:44:42 +02:00
Minh Trí 86a4a0f72d [Scaffolder] Get data of other fields in Form from a custom field
Allows to use e.g.
```
const CustomFieldExtensionComponent(props: FieldExtensionComponentProps<string[]>) => {
     const { formContext } = props;
     ....
};

const CustomFieldExtension = scaffolderPlugin.provide(
  createScaffolderFieldExtension({
    name: ...,
    component: CustomFieldExtensionComponent,
    validation: ....
  })
);
```

Signed-off-by: Minh Trí <tritri251214@gmail.com>
2022-05-19 15:13:55 +07:00
David Giacomo 6377a44efb 1.2 release is out, removing disclaimer
Signed-off-by: David Giacomo <dgiacomo@gmail.com>
2022-05-18 16:43:04 -07:00
Camila Belo 10d86dedc0 refactor(techdocs): apply review suggestions
Signed-off-by: Camila Belo <camilaibs@gmail.com>
2022-05-16 16:18:39 +02:00
Camila Belo 9add676fbb docs(techdocs): add-ons getting started
Signed-off-by: Camila Belo <camilaibs@gmail.com>
2022-05-16 16:17:07 +02:00