Commit Graph

1389 Commits

Author SHA1 Message Date
Ben Lambert 3515347e53 Merge pull request #22497 from jamieklassen/cluster-title
'title' field for Kubernetes clusters
2024-02-13 14:30:51 +01:00
Patrik Oldsberg 70de473b42 Merge pull request #22536 from Lazzaretti/feature/asyncapi3
feat(docs): Add documentation & example that AsyncApi 3 is supported
2024-02-13 13:24:46 +01:00
Darshan Simha ad2f02e24c fix: Updates the imports in frontend docs
Signed-off-by: Darshan Simha <darshan_simha@intuit.com>
2024-02-09 09:26:04 -05:00
Jamie Klassen 494dca2326 document title field
Signed-off-by: Jamie Klassen <jamie.klassen@broadcom.com>
2024-02-08 09:51:39 -05:00
Fabrizio Lazzaretti a6620fbc5a Merge branch 'backstage:master' into feature/asyncapi3 2024-02-08 10:24:03 +01:00
Fredrik Adelöw 9aac2b0d36 move cwd as the first argument to yarn
Signed-off-by: Fredrik Adelöw <freben@gmail.com>
2024-02-04 20:13:00 +01:00
Michael De La Cruz 0fe38a8e78 docs: remove hide or mask sensitive data on review step to encourage the correct way
Signed-off-by: Michael De La Cruz <Michael.delacruz@fmr.com>
2024-02-01 14:27:31 -06:00
Fredrik Adelöw 4fd1cdc454 Merge pull request #22518 from npiyush97/a11y
Microsite: a11y fixes
2024-01-31 15:48:17 +01:00
Fabrizio Lazzaretti a60fa1bac3 Merge branch 'backstage:master' into feature/asyncapi3 2024-01-30 14:16:06 +01:00
Rickard Dybeck 48b1e4c35d Merge pull request #21975 from backstage/catalog-backend/add-location-by-entity-api
[CatalogBackend] Add API to get location by entity
2024-01-29 09:22:11 -05:00
Lazzaretti d105626ef6 feat(docs): Add documentation & example that AsyncApi 3 is supported
Signed-off-by: Lazzaretti <fabrizio@lazzaretti.me>
2024-01-26 14:19:40 +01:00
npiyush97 f9b5866902 some a11y fix
Signed-off-by: npiyush97 <npiyush35@gmail.com>
2024-01-25 22:38:21 +05:30
Ben Lambert 788d92a2ae Apply suggestions from code review
Co-authored-by: Fredrik Adelöw <freben@gmail.com>
Signed-off-by: Ben Lambert <ben@blam.sh>
Signed-off-by: blam <ben@blam.sh>
2024-01-25 14:27:33 +01:00
blam aa5ee05f27 chore: added more docs for entity data parser
Signed-off-by: blam <ben@blam.sh>
2024-01-25 12:47:44 +01:00
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
Rickard Dybeck c33f9d485d update api docs
Signed-off-by: Rickard Dybeck <dybeck@spotify.com>
2024-01-02 10:07:50 -05: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