Commit Graph

1374 Commits

Author SHA1 Message Date
Marc Rooding a86920b287 feat: introduced a new MultiEntityPicker field that supports selecting multiple Entities
Signed-off-by: Marc Rooding <marc@mrooding.me>
2024-01-23 13:35:56 +01:00
Jamie Klassen 8754168225 document extra AWS auth parameters
including the new x-k8s-aws-id one

Signed-off-by: Jamie Klassen <jamie.klassen@broadcom.com>
2024-01-19 17:56:54 -05:00
Jamie Klassen 7ab6713ce1 refactor kubernetes auth docs
some grammar/wordsmithing and formatting

Signed-off-by: Jamie Klassen <jamie.klassen@broadcom.com>
2024-01-19 17:56:54 -05:00
Armando Comellas afb3b00cd4 Merge branch 'backstage:master' into gke-service-account 2024-01-18 17:20:08 +00:00
Fredrik Adelöw 8af635a847 Merge pull request #21881 from david-martin/patch-1
Update kubernetes docs for cluster annotation
2024-01-17 18:44:34 +01:00
Jamie Klassen 4ef6f1bde6 mention ingestion procedure synergy
Signed-off-by: Jamie Klassen <jamie.klassen@broadcom.com>
2024-01-12 18:09:14 -05:00
Jamie Klassen b5f6a1dd00 document catalog cluster locator method
and arrange the cluster locator method subsections in alphabetical order.

Signed-off-by: Jamie Klassen <jamie.klassen@broadcom.com>
2024-01-12 18:09:12 -05:00
armandocomellas1 87737a8155 Added config.getString() method to check if kubernetes.config has googleServiceAccount property
Signed-off-by: armandocomellas1 <cgarmando@google.com>
2024-01-12 16:09:42 -06:00
Fredrik Adelöw f56b7290da Merge pull request #22127 from knottAutodesk/patch-2
Update authorizing-parameters-steps-and-actions.md
2024-01-10 17:06:53 +01:00
Emma Indal f42ff3fc47 update ids of config options for search DI
Signed-off-by: Emma Indal <emma.indahl@gmail.com>
2024-01-10 16:08:48 +01:00
knottAutodesk e6276190ad Update authorizing-parameters-steps-and-actions.md
debug:log is causing markdown rendering issues - it should be enclosed in back-ticks.

Signed-off-by: knottAutodesk <143034967+knottAutodesk@users.noreply.github.com>
2024-01-06 16:43:51 -08:00
Ben Lambert 7896e7daf9 Merge pull request #22067 from RiverPhillips/master
fix(docs): replace AsyncAPI spec urls with valid ones
2024-01-04 10:40:53 +01:00
River Phillips 76b2ea6a49 fix: use latest AsyncAPI instead of specific version
Signed-off-by: River Phillips <riverphillips1@gmail.com>
2024-01-02 15:18:54 +00:00
Philipp Hugenroth b299723545 Merge pull request #21859 from KeranYang/patch-2
Update installation.md
2024-01-02 16:17:02 +01:00
River Phillips 3515ccc6bd fix(docs): replace AsyncAPI spec urls with valid ones
Signed-off-by: River Phillips <riverphillips1@gmail.com>
2024-01-02 14:17:36 +00:00
Vincenzo Scamporlino 31783a711c Merge pull request #21953 from backstage/vinzscam/catalog-docs
docs: add by-query endpoint
2023-12-22 21:56:29 +01:00
Fredrik Adelöw 2e6c56bb8e update release status wording for the new backend system
Signed-off-by: Fredrik Adelöw <freben@gmail.com>
2023-12-22 13:58:00 +01:00
Vincenzo Scamporlino 4522a4ba24 Apply suggestions from code review
Co-authored-by: Fredrik Adelöw <freben@gmail.com>
Signed-off-by: Vincenzo Scamporlino <vincenzos@spotify.com>
2023-12-22 10:45:32 +01:00
Vincenzo Scamporlino 38c2ecccd1 docs: add by-query endpoint
Signed-off-by: Vincenzo Scamporlino <vincenzos@spotify.com>
2023-12-20 12:46:19 +01:00
blam b7902a715d chore: fixing docs
Signed-off-by: blam <ben@blam.sh>
2023-12-18 17:27:50 +01:00
blam 82af648de3 chore: reset some testing files and fix docs
Signed-off-by: blam <ben@blam.sh>
2023-12-18 14:34:02 +01:00
blam 30f2066896 chore: added documentation and deprecating old method
Signed-off-by: blam <ben@blam.sh>
2023-12-18 14:18:07 +01:00
David Martin 9c20b935bc Update configuration.md
The wording for the default behaviour reads a little odd.
I think this clears it up

Signed-off-by: David Martin <david-martin@users.noreply.github.com>
2023-12-15 12:08:58 +00:00
Keran Yang 7ebc6028d6 Update installation.md
Signed-off-by: Keran Yang <yangkr920208@gmail.com>
2023-12-13 21:11:33 -05:00
Keran Yang f7eeb10854 Update life-of-an-entity.md
Signed-off-by: Keran Yang <yangkr920208@gmail.com>
2023-12-13 11:03:41 -05:00
Christof Leuenberger 3452e3dd02 Describe how to add standalone techdocs
The documentation template doesn't seem to exist any longer.
Add the minimal steps in order to help users get started with
creating a standalone techdocs documentation.

Signed-off-by: Christof Leuenberger <christof.leuenberger@gmail.com>
Signed-off-by: e553956 <christof.leuenberger@sbb.ch>
Signed-off-by: Christof Leuenberger <christof.leuenberger@gmail.com>

Fix typo in mcdocs

Signed-off-by: Christof Leuenberger <christof.leuenberger@gmail.com>
Signed-off-by: e553956 <christof.leuenberger@sbb.ch>

Add requested changes

- Use filename titles for code blocks
- Link to documentation on how to add a component to catalog
- Consistent use of quotes and file endings

Signed-off-by: Christof Leuenberger <christof.leuenberger@gmail.com>
Signed-off-by: e553956 <christof.leuenberger@sbb.ch>

Add mandatory owner field to example

Signed-off-by: Christof Leuenberger <christof.leuenberger@gmail.com>
Signed-off-by: e553956 <christof.leuenberger@sbb.ch>

Fix prettier issues

Signed-off-by: e553956 <christof.leuenberger@sbb.ch>
2023-12-08 16:39:42 +01:00
Fredrik Adelöw 06d5cf944a Merge pull request #21277 from Ninosaurier/doc-update-disable-font
Update how-to-guides.md
2023-12-04 12:12:44 +01:00
Andre Wanlin c8e253a2e8 Update docs/features/techdocs/how-to-guides.md
Signed-off-by: Andre Wanlin <67169551+awanlin@users.noreply.github.com>
2023-12-02 06:12:01 -06:00
Larry Knott d5f0e991ea Better link fix
Signed-off-by: Larry Knott <larry.knott@autodesk.com>
2023-11-27 14:01:23 -08:00
knottAutodesk 4050f7776b Update api.md
The link to `The Life of an Entity` was broken.

Signed-off-by: knottAutodesk <143034967+knottAutodesk@users.noreply.github.com>
2023-11-27 12:16:35 -08:00
Andre Wanlin e9e57add1b Merge pull request #21403 from hainenber/support-additional-mkdocs-server-cli-params
Support additional mkdocs server cli params
2023-11-24 10:31:55 -06:00
hainenber 716dd37404 fix(pkg/techdocs): correct dirtyreload arg for mkdocs
Also correct array-like elements for rest operator

Signed-off-by: hainenber <dotronghai96@gmail.com>
2023-11-21 22:37:02 +07:00
Edoardo Dusi 859dd0745f docs: fix GitHub Discovery link in adding-templates.md
Signed-off-by: Edoardo Dusi <edo@edoardodusi.com>
2023-11-20 18:00:49 +01:00
Patrik Oldsberg fc92656e42 Merge pull request #20738 from akz08/add-docker-useroptions-bypass
Add a way to bypass user modification for TechDocs CLI docs generation in Docker
2023-11-20 17:41:14 +01:00
hainenber 69b2f7bf3b fix(techdocs-cli): limit supported mkdocs flags
Signed-off-by: hainenber <dotronghai96@gmail.com>
2023-11-20 21:46:41 +07:00
hainenber 549ca5e3c4 fix(pkg/techdocs-cli): specify new opt
Signed-off-by: hainenber <dotronghai96@gmail.com>
2023-11-20 21:23:10 +07:00
Antonino Provenzano 286b6f90c3 Update how-to-guides.md
Removed "note:". It was a mistake

Signed-off-by: Antonino Provenzano <provenzano.a@gmx.net>
2023-11-17 15:13:31 +01:00
Antonino Provenzano 01594ee027 Update docs/features/techdocs/how-to-guides.md
Co-authored-by: Andre Wanlin <67169551+awanlin@users.noreply.github.com>
Signed-off-by: Antonino Provenzano <provenzano.a@gmx.net>
2023-11-17 13:46:12 +01:00
Deepankumar 52050ada6e SingleTenant ServiceLocatorMethod for Kubernetes cluster by entity annotation (#20954)
* Filter Kubernetes cluster by entity annotation

Signed-off-by: Deepankumar Loganathan <deepan0433@gmail.com>

* Documentation updated

Signed-off-by: Deepankumar Loganathan <deepan0433@gmail.com>

* SingleTenantLocator implemented

Signed-off-by: Deepankumar Loganathan <deepan0433@gmail.com>

* API reports updated

Signed-off-by: Deepankumar Loganathan <deepan0433@gmail.com>

* spelling corrected

Signed-off-by: Deepankumar Loganathan <deepan0433@gmail.com>

* document updated and fixed review comments

Signed-off-by: Deepankumar Loganathan <deepan0433@gmail.com>

---------

Signed-off-by: Deepankumar Loganathan <deepan0433@gmail.com>
2023-11-15 14:54:22 -05:00
Fredrik Adelöw 3d61cb0b6a Merge pull request #20214 from mecseid/feature/implement-gitea-readtree
Implement readTree of Gitea provider to support Techdocs
2023-11-15 10:13:24 +01:00
Patrik Oldsberg 0c4e5b6c6e Merge pull request #20681 from alexashley/node-20-no-snapshots-flag
docs: mention flag for using software templates on Node 20
2023-11-14 19:58:15 +01:00
Patrik Oldsberg af26c3480f Merge pull request #20941 from waldi/patch-1
Fix typo and grammer in features/software-catalog/configuration.md
2023-11-14 13:47:26 +01:00
Antonino Provenzano 52fff5ed0b Update how-to-guides.md
Added new section in doc, to prevent download of Google fonts

Signed-off-by: Antonino Provenzano <provenzano.a@gmx.net>
2023-11-14 10:49:21 +01:00
blam c5ffd65321 docs: fix
Signed-off-by: blam <ben@blam.sh>
2023-11-14 09:29:42 +01:00
blam c639c7d1e3 docs: added a note
Signed-off-by: blam <ben@blam.sh>
2023-11-14 09:20:39 +01:00
blam a9866f0137 docs: updating some docs for scaffolder
Signed-off-by: blam <ben@blam.sh>
2023-11-14 09:15:25 +01:00
Fredrik Adelöw 56f90b09a9 Merge pull request #20984 from backstage/vinzscam/templates-docs
Docs: expand section on catalog integrations
2023-11-07 10:35:20 +01:00
Jenson3210 df40b067e1 Kubernetes: Resource quotas as default objects (#20951)
* Fixed the lack of `resourcequotas`

Signed-off-by: Jente Sondervorst <jentesondervorst@gmail.com>

* Fixed the lack of `resourcequotas`

Signed-off-by: Jente Sondervorst <jentesondervorst@gmail.com>

* Fixed the lack of `resourcequotas`

Signed-off-by: Jente Sondervorst <jentesondervorst@gmail.com>

* Fixed the lack of `resourcequotas`

Signed-off-by: Jente Sondervorst <jentesondervorst@gmail.com>

---------

Signed-off-by: Jente Sondervorst <jentesondervorst@gmail.com>
2023-11-06 16:13:59 -05:00
Vincenzo Scamporlino c038626c05 docs: expand section on catalog integrations
Signed-off-by: Vincenzo Scamporlino <vincenzos@spotify.com>
2023-11-06 13:26:05 +01:00
Waldi 2d8e4ac7b4 Fix typo and grammer in features/software-catalog/configuration.md
Signed-off-by: Waldi <barbewaldemar@googlemail.com>
2023-11-02 17:00:10 +01:00