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
4666577b53
Merge pull request #6141 from backstage/software-catalog-rename
...
Docs: Update references to "service catalog"
2021-06-28 13:47:16 +02:00
642cec7ac7
docs: remove references to @backstage/core
...
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com >
2021-06-24 12:50:40 +02:00
709589a839
Rename service catalog to software catalog, excluding blog posts
...
Signed-off-by: Joe Porpeglia <josephp@spotify.com >
2021-06-21 11:48:43 -04: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
ce5b76ddca
Merge pull request #5715 from backstage/mob/document-search-v1
...
[Search] WIP documentation for the V1 Search Milestone
2021-06-09 19:22:24 +02:00
5c9c34dee9
Merge pull request #5927 from backstage/iameap/search-alpha-release
...
[Search] Initial, Alpha Release
2021-06-09 19:21:15 +02:00
363b0b87ea
Merge pull request #5925 from xShteff/master
...
docs: added example dockerfiles for techdocs and templating
2021-06-09 15:37:25 +02:00
e71d0002ab
fix prettier
...
Signed-off-by: Fredrik Adelöw <freben@gmail.com >
2021-06-09 14:51:28 +02:00
28fc26ddf4
Merge pull request #5849 from SDA-SE/feat/scaffolder-conditional
...
Conditional scaffolder steps
2021-06-08 14:25:49 +02:00
f3a9a063a6
docs fixups
...
Signed-off-by: Emma Indal <emma.indahl@gmail.com >
2021-06-06 22:04:29 +02:00
50873903fb
Add Lunr as example
...
Signed-off-by: Emma Indal <emma.indahl@gmail.com >
2021-06-06 22:02:09 +02:00
3bc581732c
More iteration on Search Feature documentation.
...
Signed-off-by: Eric Peterson <ericpeterson@spotify.com >
2021-06-06 12:52:43 +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
d2a75ce613
v1/v2/v3 -> alpha/beta/ga
...
Signed-off-by: Eric Peterson <ericpeterson@spotify.com >
2021-06-04 18:40:46 +02:00
09fdc24802
Improve documentation
...
Signed-off-by: Oliver Sand <oliver.sand@sda-se.com >
2021-06-04 16:30:33 +02:00
af06c6a782
Some small fixes
...
Signed-off-by: Oliver Sand <oliver.sand@sda-se.com >
2021-06-04 16:30:32 +02:00
047658256e
prettify
...
Signed-off-by: anovis <anovis@ymail.com >
2021-06-03 13:30:13 -04:00
5292d453b4
Update docs/features/software-templates/writing-templates.md
...
Co-authored-by: Ben Lambert <ben@blam.sh >
Signed-off-by: anovis <anovis@ymail.com >
2021-06-03 09:08:14 -04:00
f20a6547bd
update based on comments
...
Signed-off-by: anovis <anovis@ymail.com >
2021-06-02 11:25:56 -04:00
3dacab3c9b
fix syntax error
...
Signed-off-by: anovis <anovis@ymail.com >
2021-06-02 10:42:12 -04:00
1c4b39ebf7
adding example for arrays
...
Signed-off-by: anovis <anovis@ymail.com >
2021-06-02 10:42:12 -04:00
187180db5c
Improve catalog-customization doc
...
Signed-off-by: Tim Hansen <timbonicus@gmail.com >
2021-05-26 21:32:19 -06:00
9768e36c4e
Merge branch 'master' into timbonicus/catalog-entity-context
2021-05-26 17:21:23 -06:00
0ddb9719f0
Add warning
...
Signed-off-by: Tim Hansen <timbonicus@gmail.com >
2021-05-26 13:37:02 -06:00
e2d5014c71
Add documentation for catalog customization
...
Signed-off-by: Tim Hansen <timbonicus@gmail.com >
2021-05-26 12:38:30 -06:00
b517c7f9b7
Remove indention
...
Signed-off-by: Oliver Sand <oliver.sand@sda-se.com >
2021-05-26 14:17:36 +02:00
35e73aab14
Fix wrong yaml indention in docs
...
Signed-off-by: Oliver Sand <oliver.sand@sda-se.com >
2021-05-26 14:10:23 +02:00
aef9fb2399
Implement suggested changes after discussions
...
Signed-off-by: Fredrik Adelöw <freben@gmail.com >
2021-05-24 19:13:30 +02:00
2714bf9c79
Cross-linking and menu registration
...
Signed-off-by: Eric Peterson <ericpeterson@spotify.com >
2021-05-24 16:13:52 +02:00
8ad667cd96
Draft intro statement.
...
Signed-off-by: Eric Peterson <ericpeterson@spotify.com >
2021-05-24 16:03:17 +02:00
62fcca6b9e
Frontend brain dump.
...
Signed-off-by: Eric Peterson <ericpeterson@spotify.com >
2021-05-24 16:03:17 +02:00
f86171027e
WIP documentation for the V1 Search Milestone
...
Signed-off-by: Eric Peterson <ericpeterson@spotify.com >
2021-05-24 16:03:17 +02:00
745b30b081
Merge pull request #5578 from GunnerStraiker1/template-card-owner
...
Add Owner Field into TemplateCard and ownedBy & ownerOf relations for TemplateEntity
2021-05-20 11:46:44 +02:00
cefe0447d0
Fixed review corrections
...
Signed-off-by: Victor Perera <v-vperera@expediagroup.com >
2021-05-19 19:14:08 -05:00
d1e74a8509
Remove unintended paragraph in the scaffolder template migration document
...
Signed-off-by: Dominik Henneke <dominik.henneke@sda-se.com >
2021-05-19 17:32:02 +02:00
850a882762
Merge pull request #5678 from backstage/docs/migration-v2
...
docs(scaffolder/migration): Added some migration docs for old templates
2021-05-18 21:02:15 +02:00
956f08435f
chore(docs): fixing code review comments
...
Signed-off-by: blam <ben@blam.sh >
2021-05-18 13:11:14 +02:00
21ebf8dd5e
address comments
...
Signed-off-by: Fredrik Adelöw <freben@gmail.com >
2021-05-17 10:47:08 +02:00
664ca06552
chore: rename file to be actually version correct
...
Signed-off-by: blam <ben@blam.sh >
2021-05-16 18:49:46 +02:00
63066bbfc2
docs(scaffolder/migration): Added some migration docs for old templates
...
Signed-off-by: blam <ben@blam.sh >
2021-05-16 18:47:40 +02:00
68fdbf014e
Add the status field to the Entity envelope
...
Signed-off-by: Fredrik Adelöw <freben@gmail.com >
2021-05-12 14:47:02 +02:00
2723253d7e
Update documentation
...
Signed-off-by: Marcus Eide <eide@spotify.com >
2021-05-07 15:24:52 +02:00
a23850d4ad
spec.owner added into template schema
...
Signed-off-by: Victor Perera <v-vperera@expediagroup.com >
2021-05-05 14:46:58 -05: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
Crevil