Commit Graph

1161 Commits

Author SHA1 Message Date
Jussi Hallila e9e56b01ac Add possibility to use path style discovery on S3 tech docs. Enables the possibility to support S3-like buckets that rely on path style API like Localstack.
Signed-off-by: Jussi Hallila <jussi@hallila.com>
2021-04-29 10:54:42 +02:00
Patrik Oldsberg 095d890e68 Merge pull request #5432 from jrusso1020/jrusso/fix-5420
[Fixes 5420] Update component example in documentation
2021-04-28 19:04:02 +02:00
jrusso1020 55e1d9f3a5 update JSON
Signed-off-by: jrusso1020 <jrusso@brex.com>
2021-04-28 08:45:35 -06:00
Patrik Oldsberg 61fdfd70a3 Merge pull request #5353 from backstage/rugvip/plugins-docs
docs,READMEs: updates for composability changes
2021-04-27 17:47:13 +02:00
Patrik Oldsberg e5d4cd4dc8 docs: prettier
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2021-04-27 17:30:34 +02:00
jrusso1020 6b580d979b addres feedback
Signed-off-by: jrusso1020 <jrusso@brex.com>
2021-04-27 09:17:59 -06:00
Patrik Oldsberg 74f74ccbdb Apply suggestions from code review
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>

Co-authored-by: Fredrik Adelöw <freben@gmail.com>
2021-04-27 17:16:16 +02:00
Patrik Oldsberg 9a69a3877e Merge pull request #5436 from onematchfox/fix-techdocs-tutorials
Align TechDocs (`mkdocs.yml`) navigation with microsite
2021-04-27 16:45:37 +02:00
Patrik Oldsberg df897a6126 Merge pull request #4918 from JacobValdemar/patch-1
Contribute terraform file for S3 storage in Techdocs
2021-04-27 10:30:43 +02:00
Brenda Sukh 24c24f384a Add stability index for cost insights
Signed-off-by: Brenda Sukh <brendasukh@gmail.com>
2021-04-26 14:14:22 -04:00
Tim Hansen ba86f0290d Comment health checks with note
Signed-off-by: Tim Hansen <timbonicus@gmail.com>
2021-04-23 12:34:46 -06:00
Tim Hansen 3b3bc4d120 Add healthcheck to k8s doc
Signed-off-by: Tim Hansen <timbonicus@gmail.com>
2021-04-23 12:13:13 -06:00
Eric Peterson 74a5b00eb6 Merge pull request #5371 from adrianke77/techdocs-landing-page-customization
Add TechDocs landing page customization and exported components
2021-04-23 11:50:15 +02:00
Brian Fox 5652f4eee5 Fix broken link in Software Templates -> Installation
Signed-off-by: Brian Fox <brianhfox@gmail.com>
2021-04-23 09:58:30 +02:00
Chongyang Adrian, Ke 813a4a04f5 fix DocsTable rendering of EmptyState
Signed-off-by: Chongyang Adrian, Ke <ftt.adrian.ke@grabtaxi.com>
2021-04-23 11:38:09 +08:00
Adrian Ke Chongyang 7a3b3b2be6 Update docs/features/techdocs/how-to-guides.md
Signed-off-by: Eric Peterson <ericpeterson@spotify.com>

Co-authored-by: Eric Peterson <iamEAP@users.noreply.github.com>
Signed-off-by: Chongyang Adrian, Ke <ftt.adrian.ke@grabtaxi.com>
2021-04-23 11:07:18 +08:00
Adrian Ke Chongyang f5dab83b59 Update docs/features/techdocs/how-to-guides.md
Signed-off-by: Eric Peterson <ericpeterson@spotify.com>

Co-authored-by: Eric Peterson <iamEAP@users.noreply.github.com>
Signed-off-by: Chongyang Adrian, Ke <ftt.adrian.ke@grabtaxi.com>
2021-04-23 11:07:18 +08:00
Chongyang Adrian, Ke cb321bae90 change naming from widget to panel
Signed-off-by: Chongyang Adrian, Ke <ftt.adrian.ke@grabtaxi.com>
2021-04-23 11:07:18 +08:00
Chongyang Adrian, Ke 9f7d5662e3 update how-to-guides.md
Signed-off-by: Chongyang Adrian, Ke <ftt.adrian.ke@grabtaxi.com>
2021-04-23 11:07:17 +08:00
Adrian Ke Chongyang 6db5564af6 Update docs/features/techdocs/how-to-guides.md
Co-authored-by: Himanshu Mishra <himanshu@orkohunter.net>
Signed-off-by: Chongyang Adrian, Ke <ftt.adrian.ke@grabtaxi.com>
2021-04-23 11:07:17 +08:00
Adrian Ke Chongyang 74c91998bf Update docs/features/techdocs/how-to-guides.md
Co-authored-by: Himanshu Mishra <himanshu@orkohunter.net>
Signed-off-by: Chongyang Adrian, Ke <ftt.adrian.ke@grabtaxi.com>
2021-04-23 11:07:17 +08:00
Adrian Ke Chongyang 10579c3d0d Update docs/features/techdocs/how-to-guides.md
Co-authored-by: Himanshu Mishra <himanshu@orkohunter.net>
Signed-off-by: Chongyang Adrian, Ke <ftt.adrian.ke@grabtaxi.com>
2021-04-23 11:07:17 +08:00
Chongyang Adrian, Ke 39bdaa0046 Add TechDocs landing page customization and exported components
Signed-off-by: Chongyang Adrian, Ke <ftt.adrian.ke@grabtaxi.com>
2021-04-23 11:07:17 +08:00
Patrik Oldsberg c614ede9a5 docs: update plugin installation docs
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2021-04-22 18:32:54 +02:00
Patrik Oldsberg 610619dba0 docs: update install step in plugin architecture docs
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2021-04-22 18:30:16 +02:00
jrusso1020 5461726742 [Fixes 5420] Update component example in documentation
Currently the entity component example towards the top of the page
has metadata.labels.system set
https://github.com/backstage/backstage/blame/master/docs/features/software-catalog/descriptor-format.md#L47
but further down on the page it's spec.system
https://github.com/backstage/backstage/blame/master/docs/features/software-catalog/descriptor-format.md#L423.

This updates them to both use the correct spec.system key/value,
as well as add an example label to get a sense for what labels
look like as well

Signed-off-by: jrusso1020 <jrusso@brex.com>
2021-04-22 09:11:12 -06:00
Tim Hansen 938b266b86 Template spec.type is not optional
Signed-off-by: Tim Hansen <timbonicus@gmail.com>
2021-04-21 15:36:34 -06:00
Fredrik Adelöw 87a82498b9 final fixup
Signed-off-by: Fredrik Adelöw <freben@gmail.com>
2021-04-21 13:30:21 +02:00
alde 57a10500cd add code-coverage annotation to well-known-annotations
Signed-off-by: Fredrik Adelöw <freben@gmail.com>
2021-04-21 12:58:19 +02:00
Tim 00cd559c4a Merge pull request #4618 from rbogle/rbogle/fargate-docs
Rbogle/fargate docs
2021-04-20 15:10:07 -06:00
Tim Hansen 68f3e891b8 Move Fargate doc to contrib
Signed-off-by: Tim Hansen <timbonicus@gmail.com>
2021-04-20 14:36:19 -06:00
Tim Hansen c713442c30 Datadog RUM minor doc cleanup
Signed-off-by: Tim Hansen <timbonicus@gmail.com>
2021-04-20 14:16:13 -06:00
Rian Bogle 4792df9e78 AWS Fargate and Aurora
Signed-off-by: Fredrik Adelöw <freben@gmail.com>
2021-04-20 21:28:56 +02:00
Fredrik Adelöw d320547ba1 Merge pull request #5391 from backstage/freben/standalone-frontend
update the standalone frontend contribs
2021-04-20 20:52:50 +02:00
Fredrik Adelöw e669a8013f update the standalone frontend contribs
Signed-off-by: Fredrik Adelöw <freben@gmail.com>
2021-04-20 20:24:06 +02:00
Fredrik Adelöw 4e7c9d7d16 Merge pull request #5374 from wrighbr/master
Datadog RUM events
2021-04-20 14:47:47 +02:00
Eric Peterson aa45f8c92b Merge pull request #5159 from adrianke77/techdocs-add-git-feedback-link
Add Gitlab/Github feedback link icon in Techdocs Reader
2021-04-20 14:22:53 +02:00
Eric Peterson 295589e136 Satisfy vale linter.
Signed-off-by: Eric Peterson <ericpeterson@spotify.com>
2021-04-20 14:00:21 +02:00
Chongyang Adrian, Ke 2b440c0605 add git feedback link: update FAQ and unit testing
Signed-off-by: Chongyang Adrian, Ke <ftt.adrian.ke@grabtaxi.com>
2021-04-20 13:43:29 +08:00
Brett Wright 50c5808b62 Revert "Update plugin example for composability"
This reverts commit 7ca780442219d2ec85fb296c3d1584c0d3aab1db.

Signed-off-by: Brett Wright <wright.brett@gmail.com>
2021-04-19 19:48:17 +02:00
Brett Wright 314b8bf1e9 Revert "Fix pluginname"
This reverts commit cb287be816d8149153cd72df5d6318efe04b04d4.

Signed-off-by: Brett Wright <wright.brett@gmail.com>
2021-04-19 19:48:17 +02:00
Brett Wright f77db9572d Revert "Clarify example"
This reverts commit 72eaf17eaa408af347db07881ef6a8b7619c7adf.

Signed-off-by: Brett Wright <wright.brett@gmail.com>
2021-04-19 19:48:17 +02:00
Brett Wright de00581391 Revert "Delete configure-app-with-plugins.md"
This reverts commit ce16cd5233779e0dbe24b2756027de83484ead84.

Signed-off-by: Brett Wright <wright.brett@gmail.com>
2021-04-19 19:48:16 +02:00
Brett Wright a40c2aa853 Delete configure-app-with-plugins.md
Signed-off-by: Brett Wright <wright.brett@gmail.com>
2021-04-19 19:48:16 +02:00
Brett Wright 948c4b6a30 Added Datadog to vocab
Signed-off-by: Brett Wright <wright.brett@gmail.com>
2021-04-19 19:48:15 +02:00
Brett Wright 1334c7868c Added doco regarding Datadog installation
Signed-off-by: Brett Wright <brett.wright@bestseller.com>
Signed-off-by: Brett Wright <wright.brett@gmail.com>
2021-04-19 19:48:15 +02:00
Adam Harvey 274fb80198 Clarify example
Signed-off-by: Adam Harvey <adaharve@cisco.com>
Signed-off-by: Brett Wright <wright.brett@gmail.com>
2021-04-19 19:48:15 +02:00
Adam Harvey 6c3c255ff5 Fix pluginname
Signed-off-by: Adam Harvey <adaharve@cisco.com>
Signed-off-by: Brett Wright <wright.brett@gmail.com>
2021-04-19 19:48:15 +02:00
Adam Harvey 89ecdf526a Update plugin example for composability
Signed-off-by: Adam Harvey <adaharve@cisco.com>
Signed-off-by: Brett Wright <wright.brett@gmail.com>
2021-04-19 19:48:15 +02:00
Jussi Hallila 734c7d5238 Add IAM policy permissions to s3 tech docs docs (#5359)
List minimal permissions needed to write and read tech docs on AWS environment

Signed-off-by: Jussi Hallila <jussi@hallila.com>
Co-authored-by: Emma Indal <emma.indahl@gmail.com>

Co-authored-by: Emma Indal <emma.indahl@gmail.com>
2021-04-19 15:04:36 +02:00