Commit Graph

184 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 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 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 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
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
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
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
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
Fredrik Adelöw c28689c686 change all $env to ${}
Signed-off-by: Fredrik Adelöw <freben@gmail.com>
2021-04-15 13:26:44 +02:00
Jacob Valdemar Andreasen c65a85afb6 Change terraform variable and fix typo in docs
Signed-off-by: Jacob Valdemar Andreasen <jan@lunar.app>
2021-04-07 12:32:43 +02:00
Tim Hansen 2e2cb81fdf Add link to Bitbucket Discovery, fix capitalization
Signed-off-by: Tim Hansen <timbonicus@gmail.com>
2021-04-01 12:18:16 -06:00
Tim Hansen 5186afea8c Update TechDocs getting-started
Signed-off-by: Tim Hansen <timbonicus@gmail.com>
2021-03-19 14:10:56 -06:00
Jacob Valdemar Andreasen 5da1459aea Fix typo
Signed-off-by: Jacob Valdemar Andreasen <jan@lunar.app>
2021-03-17 10:30:07 +01:00
Jacob Valdemar Andreasen 26e8254ef2 Update documentation
Signed-off-by: Jacob Valdemar Andreasen <jan@lunar.app>
2021-03-17 10:30:07 +01:00
Himanshu Mishra c1de2a809a docs: Add TechDocs FAQ about annotation value when using external build and storage
Signed-off-by: Himanshu Mishra <himanshu@orkohunter.net>
2021-03-11 23:28:13 +01:00
r.bideau ca4a904f6b Add techdocs.publisher.awsS3.endpoint config option
Signed-off-by: r.bideau <7304827+rbideau@users.noreply.github.com>
2021-03-08 13:56:32 +01:00
erdoganoksuz 7bf88b4f31 error name and documentation consistency.
Signed-off-by: Mert Can Bilgiç <mert.bilgic@trendyol.com>
2021-03-03 12:17:06 +03:00
erdoganoksuz aa095e469f pull request feedbacks fix.
Signed-off-by: Mert Can Bilgiç <mert.bilgic@trendyol.com>
2021-03-03 12:16:21 +03:00
Mert Can Bilgiç 37586e0fc9 runned prettier
Signed-off-by: Mert Can Bilgiç <mert.bilgic@trendyol.com>
2021-03-03 12:16:21 +03:00
gmzsenturk a10174b56d Documentations edited
Signed-off-by: Mert Can Bilgiç <mert.bilgic@trendyol.com>
2021-03-03 11:47:01 +03:00
gmzsenturk 2ebfe29d8a Cloud storage documentation edited
Signed-off-by: Mert Can Bilgiç <mert.bilgic@trendyol.com>
2021-03-03 11:46:34 +03:00
gmzsenturk fc470a310e Updated cloud storage documentation for open stack
Signed-off-by: Mert Can Bilgiç <mert.bilgic@trendyol.com>
2021-03-03 11:46:25 +03:00
erdoganoksuz cebda81000 documentation added
Signed-off-by: Mert Can Bilgiç <mert.bilgic@trendyol.com>
2021-03-03 11:46:23 +03:00
Himanshu Mishra b90c83e329 TechDocs: Update features based on Gary's feedback 2021-03-01 10:12:26 +01:00
Himanshu Mishra 8fbd591fd4 TechDocs: Update roadmap with milestones 2021-03-01 10:12:26 +01:00
Jonah Back f41ac17b29 Merge branch 'master' into feature/aws-assume-role 2021-02-17 12:39:25 -08:00
Himanshu Mishra b0501f8348 docs(TechDocs): Add more context with AWS docs hyperlinks 2021-02-17 11:09:49 +01:00
Himanshu Mishra a2518e3dbe docs(TechDocs): Update docs around AWS SDK downgrade to v2 2021-02-16 19:03:07 +01:00
Jonah Back 05e169464c run prettier fix 2021-02-11 15:32:52 -08:00
Jonah Back 9c80eca8d5 Update docs/features/techdocs/using-cloud-storage.md
Co-authored-by: Himanshu Mishra <himanshu@orkohunter.net>
2021-02-11 14:24:49 -08:00
Jonah Back 0d8b3253a4 Update docs/features/techdocs/using-cloud-storage.md
Co-authored-by: Himanshu Mishra <himanshu@orkohunter.net>
2021-02-11 14:23:37 -08:00
Jonah Back 58fdcb6a30 add docs around assuming role for techdocs storage 2021-02-11 12:49:03 -08:00
Himanshu Mishra 7dc1e43c55 docs(TechDocs): Improvements to the CI example
Signed-off-by: Himanshu Mishra <himanshu@orkohunter.net>
2021-02-11 09:28:08 +01:00
Himanshu Mishra 0869aa161a docs(TechDocs): Add GitHub Actions CI example with AWS S3 2021-02-10 19:31:00 +01:00
Himanshu Mishra 66944ec7bf TechDocs: Preparers will take and return an etag for cache invalidation 2021-02-10 11:01:18 +01:00
Himanshu Mishra 43397061fd docs(TechDocs): docs/ is configurable by mkdocs.yml 2021-02-06 17:26:44 +01:00
Himanshu Mishra 29e269d920 TechDocs: Remove traces of requestUrl/storageUrl from docs 2021-02-02 13:52:45 +01:00
Parth Shandilya e44925723e TechDocs: Make requestUrl and storageUrl optional configs by using discovery APIs
closes #3715

Co-authored-by: Himanshu Mishra <himanshu@orkohunter.net>
2021-02-02 13:51:04 +01:00
Himanshu Mishra ae508116d9 docs: TechDocs revamp techdocs architecture page
Remove/Update features which have been implemented.
2021-02-01 12:02:44 +01:00