54c25db339
Merge pull request #6071 from andrewthauer/techdocs-custom-docker
...
feat(techdocs-common): add custom docker image support
2021-07-15 10:39:14 +02:00
d5eaab91dd
feat(techdocs-common): add custom docker image support
...
Signed-off-by: Andrew Thauer <athauer@wealthsimple.com >
2021-07-13 11:26:17 -04:00
567c95284f
Move AWS policy docs to documentation page.
...
Signed-off-by: Eric Peterson <ericpeterson@spotify.com >
2021-07-13 13:50:33 +02:00
b124633526
Document techdocs svg_object limitation
...
Currently it is not possible to use the PlantUML format 'svg_object' as this
makes it possible for bad actors to inject malicious content into documentation.
This change documents this limitation under the troubleshooting section of the
techdocs feature.
Signed-off-by: Crevil <bjoern.soerensen@gmail.com >
2021-07-03 12:04:36 +02:00
d29ac0db3a
docs: remove techdocs caching caveat
...
This has been fixed, and now the cache is managed using an ETag.
Signed-off-by: Himanshu Mishra <himanshu@orkohunter.net >
2021-07-01 14:03:20 +02:00
ffe7759de8
Merge pull request #6049 from backstage/timbonicus/move-installation
...
Move `catalog` and `scaffolder` installation instructions to READMEs
2021-06-17 15:14:07 +02:00
ca1b960043
fix: typo in openStackSwift credentials username
...
A typo was made inside the credentials used by openStackSwift publisher.
As you can see here: https://github.com/backstage/backstage/blob/master/packages/techdocs-common/src/stages/publish/openStackSwift.ts#L67
or https://github.com/backstage/backstage/blob/master/plugins/techdocs-backend/config.d.ts#L119
Signed-off-by: Flavien Chantelot <flavien.chantelot@corp.ovh.com >
Signed-off-by: Flavien Chantelot <flavien.chantelot@ovhcloud.com >
2021-06-17 09:09:21 +02:00
785a42f802
Move installation instructions to READMEs
...
Signed-off-by: Tim Hansen <timbonicus@gmail.com >
2021-06-15 15:00:15 -06:00
e71d0002ab
fix prettier
...
Signed-off-by: Fredrik Adelöw <freben@gmail.com >
2021-06-09 14:51:28 +02:00
cd2a47bf2e
docs: added example dockerfiles for techdocs and templating
...
Signed-off-by: Alin Stefan Olaru <alin.stefan.olaru@lego.com >
2021-06-04 19:03:19 +02:00
42f2adadc8
Merge pull request #5415 from SDA-SE/feat/rundocker-api
...
Refactor the runDockerContainer function to a ContainerRunnerApi interface
2021-05-05 12:00:40 +02:00
c199090e31
adding steps to enable plantuml support in github workflow
...
Signed-off-by: Marco Crivellaro <marco.crive@gmail.com >
2021-05-04 12:03:52 +01:00
e0bfd3d448
Refactor the runDockerContainer function to a ContainerRunner interface.
...
Signed-off-by: Dominik Henneke <dominik.henneke@sda-se.com >
2021-05-03 14:16:28 +02:00
b99ac3f6e1
Minor composability etc docs changes
...
Signed-off-by: Fredrik Adelöw <freben@gmail.com >
2021-05-02 22:13:05 +02:00
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
61fdfd70a3
Merge pull request #5353 from backstage/rugvip/plugins-docs
...
docs,READMEs: updates for composability changes
2021-04-27 17:47:13 +02:00
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
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
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
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
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
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
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
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
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
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
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
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
c614ede9a5
docs: update plugin installation docs
...
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com >
2021-04-22 18:32:54 +02:00
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
295589e136
Satisfy vale linter.
...
Signed-off-by: Eric Peterson <ericpeterson@spotify.com >
2021-04-20 14:00:21 +02:00
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
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
c28689c686
change all $env to ${}
...
Signed-off-by: Fredrik Adelöw <freben@gmail.com >
2021-04-15 13:26:44 +02:00
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
2e2cb81fdf
Add link to Bitbucket Discovery, fix capitalization
...
Signed-off-by: Tim Hansen <timbonicus@gmail.com >
2021-04-01 12:18:16 -06:00
5186afea8c
Update TechDocs getting-started
...
Signed-off-by: Tim Hansen <timbonicus@gmail.com >
2021-03-19 14:10:56 -06:00
5da1459aea
Fix typo
...
Signed-off-by: Jacob Valdemar Andreasen <jan@lunar.app >
2021-03-17 10:30:07 +01:00
26e8254ef2
Update documentation
...
Signed-off-by: Jacob Valdemar Andreasen <jan@lunar.app >
2021-03-17 10:30:07 +01:00
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
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
7bf88b4f31
error name and documentation consistency.
...
Signed-off-by: Mert Can Bilgiç <mert.bilgic@trendyol.com >
2021-03-03 12:17:06 +03:00
aa095e469f
pull request feedbacks fix.
...
Signed-off-by: Mert Can Bilgiç <mert.bilgic@trendyol.com >
2021-03-03 12:16:21 +03:00
37586e0fc9
runned prettier
...
Signed-off-by: Mert Can Bilgiç <mert.bilgic@trendyol.com >
2021-03-03 12:16:21 +03:00
a10174b56d
Documentations edited
...
Signed-off-by: Mert Can Bilgiç <mert.bilgic@trendyol.com >
2021-03-03 11:47:01 +03:00
2ebfe29d8a
Cloud storage documentation edited
...
Signed-off-by: Mert Can Bilgiç <mert.bilgic@trendyol.com >
2021-03-03 11:46:34 +03:00
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
cebda81000
documentation added
...
Signed-off-by: Mert Can Bilgiç <mert.bilgic@trendyol.com >
2021-03-03 11:46:23 +03:00
b90c83e329
TechDocs: Update features based on Gary's feedback
2021-03-01 10:12:26 +01:00
8fbd591fd4
TechDocs: Update roadmap with milestones
2021-03-01 10:12:26 +01:00
Eric Peterson