Commit Graph

693 Commits

Author SHA1 Message Date
Fredrik Adelöw 6fab898841 Merge pull request #7932 from backstage/jhaals/core-plugin-api-no-name
core-plugin-api: Deprecate use of extensions without name
2021-11-11 10:11:30 +01:00
Rod Machen 5dcea2586c Add Search Modal component (#7316)
Signed-off-by: rodmachen <rmachen@expediagroup.com>
2021-11-11 09:26:15 +01:00
Johan Haals 598057f348 Update docs/features/software-catalog/catalog-customization.md
Signed-off-by: Johan Haals <johan.haals@gmail.com>

Co-authored-by: Fredrik Adelöw <freben@gmail.com>
2021-11-10 10:59:38 +01:00
Johan Haals 4a336fd292 core-plugin-api: Deprecate use of extensions without name
Signed-off-by: Johan Haals <johan.haals@gmail.com>
2021-11-10 09:21:02 +01:00
Jason Nguyen d393a3bd2a [docs] clarify example showing that parameters types propagate
Signed-off-by: Jason Nguyen <jason-nguyen@pluralsight.com>
2021-11-08 14:22:22 -07:00
djamaile 2406f82644 docs(#7768): include dependsOn to depict a relation between a component and resource
Signed-off-by: djamaile <rdjamaile@gmail.com>
2021-10-29 10:32:04 +02:00
Thomas Viaud 224e545a75 fix: run prettier
Signed-off-by: Thomas Viaud <t.viaud@elsevier.com>
2021-10-27 18:34:57 +01:00
Thomas Viaud 08de4fa957 fix: Adding corrected code documentation for custom field extension
Signed-off-by: Thomas Viaud <t.viaud@elsevier.com>
2021-10-27 18:34:45 +01:00
Johan Haals baa03d72e9 Merge pull request #7788 from RoadieHQ/custom-actions
List custom scaffolder action packages
2021-10-27 09:41:33 +02:00
Nicolas Arnold 1a705377ff List custom scaffolder action packages
This here adds a table with a list of opensource scaffolder actions that can be used by anyone in the community.

Signed-off-by: Nicolas Arnold <nic@roadie.io>
2021-10-26 17:30:34 +01:00
Eric Peterson d066399739 Merge pull request #7554 from cmpadden/techdocs-storage-subfolder
Support optional bucketRootPath in GCS and S3 techdocs publishers
2021-10-25 15:34:10 +02:00
Ben Lambert b45020a548 Merge pull request #7555 from dirathea/plugins-k8s-caData-support
Plugins k8s ca data support
2021-10-21 11:35:30 +02:00
Patrik Oldsberg 4552206702 Merge pull request #7657 from SDA-SE/feat/techdocs-grid
Add `<EntityListDocsGrid>` and extend `<DocsCardGrid>` to display the entity title
2021-10-21 00:35:19 +02:00
Oliver Sand bf9d10ba5f Mention in the docs
Signed-off-by: Oliver Sand <oliver.sand@sda-se.com>
2021-10-20 16:45:19 +02:00
Fidel Coria af64518bbe fix typo in techdocs documentation (#7677)
* fix typo

Signed-off-by: Fidel Coria <fidel.coria@aa.com>

* fix another typo

Signed-off-by: Fidel Coria <fidel.coria@aa.com>

* fix tiny typo

Signed-off-by: Fidel Coria <fidel.coria@aa.com>
2021-10-19 16:50:38 +02:00
Emma Indal 6c49901f6e [TechDocs] fix link to how-to guide (#7673)
Signed-off-by: Emma Indal <emma.indahl@gmail.com>
2021-10-19 13:31:03 +02:00
Aldira Putra Raharja 3e9ce7e952 fix docs accordingly
Signed-off-by: Aldira Putra Raharja <dira.thea@gmail.com>
2021-10-19 16:12:13 +07:00
Emma Indal 405dbc80e7 [Techdocs] Improve create publish docs (#7626) 2021-10-18 18:19:38 +02:00
Bodil Björklund 639d48566a Update how-to-guides.md (#7639) 2021-10-15 23:50:51 +02:00
Emma Indal 157843e5aa [Search] add how to guide for indexing TechDocs documents (#7625)
* add how to guide for indexing techdocs documents

Signed-off-by: Emma Indal <emma.indahl@gmail.com>

* add step of how to add techdocs to search type filter

Signed-off-by: Emma Indal <emma.indahl@gmail.com>
2021-10-15 11:46:34 +02:00
blam 7fe6c0bb70 chore: reworking the docs a little bit
Signed-off-by: blam <ben@blam.sh>
2021-10-14 12:07:20 +02:00
blam 8893feca73 chore: docs updates
Signed-off-by: blam <ben@blam.sh>
2021-10-14 12:07:20 +02:00
blam a61204bc4b chore: remove the link to the legacy docs
Signed-off-by: blam <ben@blam.sh>
2021-10-14 12:07:20 +02:00
blam 808d30cc30 docs: removing older documentation for now
Signed-off-by: blam <ben@blam.sh>
2021-10-14 12:07:20 +02:00
Aldira Putra Raharja 26b7943660 update api-report and update docs around caData
Signed-off-by: Aldira Putra Raharja <dira.thea@gmail.com>
2021-10-13 20:17:13 +07:00
Morgan Martinet a982e166c5 Enable customization of services used by the kubernetes backend plugin
Signed-off-by: Morgan Martinet <morgan@mmm-experts.com>
2021-10-12 00:59:04 -04:00
Emma Indal 56bd537256 [Search] add search api how to guide + search bar custom placeholder (#7535) 2021-10-11 21:55:42 +02:00
Aldira Putra Raharja 2bacec5531 Rephrase docs to match descriptions from the official docs
Signed-off-by: Aldira Putra Raharja <dira.thea@gmail.com>
2021-10-11 22:16:02 +07:00
Aldira Putra Raharja 17fdd3aea4 Update docs regarding caData config
Signed-off-by: Aldira Putra Raharja <dira.thea@gmail.com>
2021-10-11 22:05:04 +07:00
Colton Padden d207f6ee9e Support optional bucketRootPath in GCS and S3 techdocs publishers
- Updated app-config.yaml with additional configuration parameters:
    - techdocs.publisher.awsS3.bucketRootPath
    - techdocs.publisher.googleGcs.bucketRootPath
- Updated `fromConfig` and constructors to support additional `bucketRootPath`
  parameters.
- Updated publish method to support `bucketRootPath` in constructing destination
  file path
- Updated `fetchTechDocsMetadata` to use `bucketRootPath`
- Updated `docsRouter` to use `docsRouter` when retrieving files
    - When using both legacy casing, and a bucket root path, additional logic
      was added to prevent the root path's case from being modified as
      previously legacy casing would be applied to the first three entities of
      the URI
- Updated `hasDocsBeenGenerated` to use `bucketRootPath`
- Added additional unit tests for new configurations to updated, and new methods

Signed-off-by: Colton Padden <colton.padden@fastmail.com>
2021-10-11 10:49:40 -04:00
Emma Indal 25a593234b [Search] Update search readme (#7536)
* update list of supported search engines

Signed-off-by: Emma Indal <emma.indahl@gmail.com>

* update list of supported plugins integrated to search

Signed-off-by: Emma Indal <emma.indahl@gmail.com>

* update feedback link

Signed-off-by: Emma Indal <emma.indahl@gmail.com>

* fix links

Signed-off-by: Emma Indal <emma.indahl@gmail.com>
2021-10-11 14:42:54 +02:00
Patrik Oldsberg 7f2d184eb4 docs: add implementation section to extending the catalog model
Co-authored-by: Johan Haals <johan.haals@gmail.com>
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2021-10-10 20:36:01 +02:00
Adam Harvey bf6c664357 Reword sentence based on feedback
Signed-off-by: Adam Harvey <adaharve@cisco.com>
2021-10-07 12:45:31 -04:00
Adam Harvey f90b0a421a Fix bullet
Signed-off-by: Adam Harvey <adaharve@cisco.com>
2021-10-07 12:42:13 -04:00
Adam Harvey 9ac7f7c891 Fix typo & update here links
Signed-off-by: Adam Harvey <adaharve@cisco.com>
2021-10-07 09:44:48 -04:00
Adam Harvey 7d2899c06b Minor editoral tweaks (punctuation, etc.)
Signed-off-by: Adam Harvey <adaharve@cisco.com>
2021-10-07 09:41:32 -04:00
Fredrik Adelöw 1753974597 Continuing the legacy deprecation journey
Signed-off-by: Fredrik Adelöw <freben@gmail.com>
2021-10-06 21:24:05 +02:00
Emma Indal 1f73801d05 replace entityId with entityRef
Signed-off-by: Emma Indal <emma.indahl@gmail.com>
2021-09-30 12:21:10 +02:00
Emma Indal 89091104a0 update how to guide to cover customize the full reader page
Signed-off-by: Emma Indal <emma.indahl@gmail.com>
2021-09-29 19:10:15 +02:00
Emma Indal 37822d0740 add example in how to guide of Header without access to metadata
Signed-off-by: Emma Indal <emma.indahl@gmail.com>
2021-09-29 19:10:15 +02:00
Emma Indal 280954b5c0 add how-to guide for how to use a custom header
Signed-off-by: Emma Indal <emma.indahl@gmail.com>
2021-09-29 19:10:15 +02:00
Johan Haals 2751a24b7d Merge pull request #7313 from backstage/cache-docs
Add docs for implementing cachable processing
2021-09-29 11:07:20 +02:00
Johan Haals 9c8142cdac Format, require ETag, fix imports
Signed-off-by: Johan Haals <johan.haals@gmail.com>
2021-09-29 10:56:26 +02:00
Johan Haals db920df053 Update docs/features/software-catalog/external-integrations.md
Signed-off-by: Johan Haals <johan.haals@gmail.com>

Co-authored-by: Fredrik Adelöw <freben@gmail.com>
2021-09-29 10:27:50 +02:00
Johan Haals 58dba06461 Update docs/features/software-catalog/external-integrations.md
Signed-off-by: Johan Haals <johan.haals@gmail.com>

Co-authored-by: Fredrik Adelöw <freben@gmail.com>
2021-09-29 10:27:32 +02:00
Johan Haals 95f324cb7f Update docs/features/software-catalog/external-integrations.md
Signed-off-by: Johan Haals <johan.haals@gmail.com>

Co-authored-by: Fredrik Adelöw <freben@gmail.com>
2021-09-29 10:27:04 +02:00
Johan Haals 8621a63eb6 Update docs/features/software-catalog/external-integrations.md
Signed-off-by: Johan Haals <johan.haals@gmail.com>

Co-authored-by: Fredrik Adelöw <freben@gmail.com>
2021-09-29 10:26:56 +02:00
Johan Haals 9bd7ecd4fa Update docs/features/software-catalog/external-integrations.md
Signed-off-by: Johan Haals <johan.haals@gmail.com>

Co-authored-by: Fredrik Adelöw <freben@gmail.com>
2021-09-29 10:26:44 +02:00
Greg Taylor dc18948371 Fix example plugin link in catalog config doc
A link to the example artist-lookup-component.yaml file was broken due to a
change in repo directory structure. This commit updates the broken link to
reflect the new location.

Signed-off-by: Greg Taylor <greg@gctaylor.com>
2021-09-24 21:44:30 -07:00
Johan Haals 2588a65865 Make etag optional
Signed-off-by: Johan Haals <johan.haals@gmail.com>
2021-09-24 14:43:59 +02:00