Commit Graph

1462 Commits

Author SHA1 Message Date
Michael Stergianis 252ffd7fdb Add api refrence to useEntity
Signed-off-by: Michael Stergianis <mstergianis@vmware.com>
2021-09-20 17:26:59 -04:00
Michael Stergianis d646407c76 Update plugin software catalog integration docs
Updates ./docs/plugins/integrating-plugin-into-software-catalog.md as
the docs had fallen out of date. Prefers educating plugin authors about
useEntity as that is the defacto method for reading entities. Takes the
author through an example of adding their plugin content to an existing
entity element.

Signed-off-by: Michael Stergianis <mstergianis@vmware.com>
Signed-off-by: Daniel Bravo <dbravo@vmware.com>
2021-09-16 14:50:11 -04:00
Fredrik Adelöw ded1477a27 Merge pull request #6959 from calaway/patch-1
Update documentation for changes to Okta's UX
2021-09-16 19:45:06 +02:00
Fredrik Adelöw 69e387a169 fixup
Signed-off-by: Fredrik Adelöw <freben@gmail.com>
2021-09-16 19:36:37 +02:00
bodilb ee368eadae Merge pull request #7177 from backstage/add-versions-to-techdocs-roadmap
Update README.md
2021-09-16 17:51:48 +02:00
Emma Indal 2d44dd81d7 Update docs/features/techdocs/README.md
Signed-off-by: Emma Indal <emma.indahl@gmail.com>

Co-authored-by: Fredrik Adelöw <freben@gmail.com>
Signed-off-by: Emma Indal <emma.indahl@gmail.com>
2021-09-16 17:06:38 +02:00
Patrik Oldsberg 047d0be7b6 docs: format techdocs readme
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2021-09-16 17:06:38 +02:00
Bodil Björklund 4b1e7e6401 Update README.md
Add alpha and beta release to roadmap

Signed-off-by: Bodil Björklund <bodilb@spotify.com>
2021-09-16 17:04:59 +02:00
Fredrik Adelöw 02058d69a1 Merge pull request #6882 from splunk/seant-splunk/awsS3_readTree_processor
Add readTree() to AwsS3UrlReader, ReadableArrayResponse type, and AwsS3ReadTreeProcessor
2021-09-16 10:11:15 +02:00
Sean Tan fab79adde1 Add changeset. Change awsS3-discovery to s3-discovery. Change dependencies
Signed-off-by: Sean Tan <seant@splunk.com>
2021-09-15 13:50:48 -07:00
Calaway f6c1af6664 Update for changes to Okta's UX
Signed-off-by: Calaway <613-ccalaway@users.noreply.gitlab.fini.city>
2021-09-15 11:57:17 -06:00
Ben Lambert dc8c571f57 Merge pull request #7195 from bolcom/composability-doc-fix
Small fix in the composability docs
2021-09-15 16:09:10 +02:00
Roy Jacobs 1491c5e979 Small fix in the composability docs
Signed-off-by: Roy Jacobs <roy.jacobs@gmail.com>
2021-09-15 15:26:07 +02:00
Ben Lambert e3b9e29bec Merge pull request #7176 from leon-vg/patch-2
Github-discovery - document the default scan option
2021-09-15 11:31:00 +02:00
Ben Lambert 7f4aa44192 Merge pull request #7172 from backstage/blam/creating-custom-scaffolder-field-extensions
docs: Added Documentation for `customFieldExtensions`
2021-09-15 11:23:01 +02:00
blam 249b33d1a5 docs: fixing prettier warnings and reword the text
Signed-off-by: blam <ben@blam.sh>
2021-09-15 11:22:01 +02:00
blam cf4f80d50b chore: updating review emcomments
Signed-off-by: blam <ben@blam.sh>
2021-09-15 10:52:29 +02:00
Adam Harvey 28a0003fa7 Add missing period
Signed-off-by: Adam Harvey <adaharve@cisco.com>
2021-09-14 19:15:15 -04:00
Adam Harvey 23e4628206 Minor rewording
Signed-off-by: Adam Harvey <adaharve@cisco.com>
2021-09-14 19:15:04 -04:00
Adam Harvey 6472a6fd4f Wrapping not needed with prettier-ignore for YAML frontmatter
Signed-off-by: Adam Harvey <adaharve@cisco.com>
2021-09-14 19:05:50 -04:00
Adam Harvey e8c1793819 Fix sidebar
Signed-off-by: Adam Harvey <adaharve@cisco.com>
2021-09-14 19:04:52 -04:00
Leon 2d2de6bda5 added more examples
Signed-off-by: Leon <leonvanginneken@gmail.com>
2021-09-14 15:31:25 +02:00
Leon van Ginneken 23b69dcd51 Document the default scan option for the org
Signed-off-by: Leon <leonvanginneken@gmail.com>
2021-09-14 14:38:29 +02:00
blam 114a10fe9c chore: added some more docs around field extensions
Signed-off-by: blam <ben@blam.sh>

Signed-off-by: blam <ben@blam.sh>
2021-09-14 12:12:32 +02:00
blam 67ee34dcae docs: added some more examples
Signed-off-by: blam <ben@blam.sh>
2021-09-14 12:12:32 +02:00
blam df1504c9ca chore: added some more lines of documentation
Signed-off-by: blam <ben@blam.sh>
2021-09-14 12:12:32 +02:00
blam 16db8192ff chore: added some more of an example
Signed-off-by: blam <ben@blam.sh>
2021-09-14 12:12:32 +02:00
blam 512a04ec3a chore: started some documentation on FieldExtensions
Signed-off-by: blam <ben@blam.sh>
2021-09-14 12:12:32 +02:00
Sean Tan ff2ac13682 Merge branch 'master' of github.com:backstage/backstage into seant-splunk/awsS3_readTree_processor
Signed-off-by: Sean Tan <seant@splunk.com>
2021-09-13 13:20:00 -07:00
Ben Lambert 11da7e59e9 Merge pull request #7163 from backstage/rugvip/drop-docgen
remove docgen package
2021-09-13 19:59:09 +02:00
Patrik Oldsberg d61eb832fa Merge pull request #7150 from backstage/rugvip/api-docs
Introduce API Reference
2021-09-13 16:20:23 +02:00
Ben Lambert 86bcd390cf Merge pull request #7138 from backstage/docs/backstage-environments
docs: add a note about our ideas for environments
2021-09-13 10:56:55 +02:00
blam 8c63332b22 chore: running prettier on top of the documentation
Signed-off-by: blam <ben@blam.sh>
2021-09-13 10:23:56 +02:00
Patrik Oldsberg d4e614bb1d remove docgen package
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2021-09-12 23:16:11 +02:00
Patrik Oldsberg 2aad5ab226 docs: get rid of the reference dir
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2021-09-12 16:39:53 +02:00
Patrik Oldsberg e65c42aa77 docs: fix reference links
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2021-09-12 15:41:29 +02:00
Patrik Oldsberg 8d30e0ec04 docs: remove references to removed utility API docs
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2021-09-12 14:43:47 +02:00
Patrik Oldsberg cf06e3881b docs/api/utility-apis: links out to api reference
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2021-09-12 14:43:46 +02:00
Patrik Oldsberg 575d8bd9f2 build api reference as part of the microsite
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2021-09-12 14:43:46 +02:00
Patrik Oldsberg 1a7340e1ae docs: clear out the reference folder
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2021-09-12 12:02:57 +02:00
Ben Lambert 1f564b4dc1 Update docs/features/software-catalog/extending-the-model.md
Signed-off-by: Ben Lambert <blam@spotify.com>

Co-authored-by: Fredrik Adelöw <freben@gmail.com>
2021-09-11 03:09:56 +02:00
blam 06728d6273 docs: add a note about our ideas for environments
Signed-off-by: blam <ben@blam.sh>
2021-09-10 15:48:00 +02:00
Patrik Oldsberg a2e8db8dc0 docs: add a heads up about dockerignore for multi-stage builds
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2021-09-10 15:14:32 +02:00
Júlio Zynger 6548b9e23f Add code sample for ConfigApi access in frontend
Per https://discord.com/channels/687207715902193673/687235481154617364/885085310101377034

Signed-off-by: Julio Zynger <julio.zynger@soundcloud.com>
2021-09-08 14:45:25 +02:00
Fredrik Adelöw 24f8baabaf address comments
Signed-off-by: Fredrik Adelöw <freben@gmail.com>
2021-09-07 10:57:58 +02:00
Fredrik Adelöw 7b59d3e395 add some text about orphaning too
Signed-off-by: Fredrik Adelöw <freben@gmail.com>
2021-09-06 22:11:44 +02:00
Sean Tan f1c3418b7e Merge branch 'master' of github.com:backstage/backstage into seant-splunk/awsS3_readTree_processor 2021-09-06 11:50:13 -07:00
Fredrik Adelöw abe071e7f3 do stitching as well
Signed-off-by: Fredrik Adelöw <freben@gmail.com>
2021-09-04 20:30:31 +02:00
Fredrik Adelöw abecec91a6 highlight distributed processing
Signed-off-by: Fredrik Adelöw <freben@gmail.com>
2021-09-03 14:46:45 +02:00
Fredrik Adelöw aeb7474e20 add the processing part of the life-of-an-entity
Signed-off-by: Fredrik Adelöw <freben@gmail.com>
2021-09-03 11:42:33 +02:00