Commit Graph

975 Commits

Author SHA1 Message Date
Ben Lambert f3ed3fd2b7 Merge pull request #12821 from andmagom/master
[Kubernetes plugin] CRDs are configurable per cluster
2022-08-08 14:27:37 +02:00
Gary Niemen 2977f2473d roadmap_updates-techdocs_search
Signed-off-by: Gary Niemen <65337273+garyniemen@users.noreply.github.com>
2022-08-04 10:57:13 +02:00
Andres Mauricio Gomez P 9a0930e6d1 Kubernetes docs changed to show the new customResources property at the clusters level
Signed-off-by: Andres Mauricio Gomez P <andmagom@outlook.com>
2022-08-03 12:11:40 -05:00
Mathias Geat dcbb438e5f feat(techdocs-cli): Allow passing docker extra args to @techdocs/cli serve and serve:mkdocs
Signed-off-by: Mathias Geat <mathias.geat@objectbay.com>
2022-08-01 13:22:01 +02:00
Jamie Klassen c51d970410 clarify caData field
The code in `@kubernetes/client-node` will decode this value, as seen here:

https://github.com/kubernetes-client/javascript/blob/2b6813f99a85605f691973d6bc43f291ac072fc7/src/config.ts#L518-L520

I have seen a casual reader insert the multi-line raw contents of a PEM file in
this field, so it seems worth mentioning the extra layer of encoding explicitly.

Signed-off-by: Jamie Klassen <jklassen@vmware.com>
2022-07-29 15:38:32 -04:00
Iswariya Manivannan 658e22b1a8 docs: Remove markdown version constraint for mkdocs-techdocs-core
Signed-off-by: Iswariya Manivannan <iswariya.m17@gmail.com>
2022-07-29 16:51:01 +02:00
Himanshu Mishra 929a96e159 docs: update code sample for custom processors
getProcessorName is mandatory

Signed-off-by: Himanshu Mishra <himanshu@orkohunter>

Signed-off-by: Himanshu Mishra <himanshu@orkohunter.net>
2022-07-29 13:52:59 +05:30
Lucas Teligioridis 3f35423e3c Add instructions to prevent 403 on API read
The latest plugin requires a the "limitranges" API to be available for
read-only otherwise a 403 error will return on the Kubernetes pane.

Signed-off-by: Lucas Teligioridis <lucas@teligioridis.dev>
2022-07-27 08:10:29 +10:00
Lucas Teligioridis 8524931589 Provide clearer documentation on correct permissions
Rather than providing the objects and what permissions are required,
just provide a valid Kubernetes manifest that clearly shows this to the
developer setting this up. Will also prevent any ambiguity when applying
this directly against a Kubernetes API.

Signed-off-by: Lucas Teligioridis <lucas@teligioridis.dev>
2022-07-22 22:37:47 +10:00
Gio 2ae46953fa update instalation.md
adding needed settings after plugin update to version 0.7.0

Signed-off-by: Gio <6011354+gioufop@users.noreply.github.com>
2022-07-19 11:05:45 -03:00
Damola Obaleke ac32949a43 Update getting-started.md
Signed-off-by: Damola Obaleke <45045727+damolaobaleke@users.noreply.github.com>
2022-07-18 17:11:13 -07:00
Eric Peterson a84aef3e1e Merge pull request #12534 from nodify-at/master 2022-07-18 11:36:58 +02:00
Eric Peterson 75765ca72c Vale fix
Signed-off-by: Eric Peterson <ericpeterson@spotify.com>
2022-07-18 10:56:38 +02:00
Emma Indal 06a305c4f8 headings for use cases section
Signed-off-by: Emma Indal <emma.indahl@gmail.com>
2022-07-18 10:29:59 +02:00
Emma Indal e7638fa7e7 delete beta related how to guides
Signed-off-by: Emma Indal <emma.indahl@gmail.com>
2022-07-18 10:09:01 +02:00
Emma Indal 9a75db568a update docs
Signed-off-by: Emma Indal <emma.indahl@gmail.com>
2022-07-18 10:09:01 +02:00
Thomas Cardonne 8d30688534 docs(software-templates): document new template output format
This format has been deprecated and users should use links instead

Signed-off-by: Thomas Cardonne <thomas.cardonne@adevinta.com>
2022-07-15 10:50:38 +02:00
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
Hasan Oezdemir b0b8213056 feature: update the search engine documentation to describe the batch size and rename change set file.
Signed-off-by: Hasan Oezdemir <21654050+nodify-at@users.noreply.github.com>
2022-07-09 14:53:17 +02: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