Commit Graph

1302 Commits

Author SHA1 Message Date
Fredrik Adelöw ec56aa4fe8 Merge pull request #6343 from goober/feature/customize-ldap-processor
Add extension points for the LDAP processor for advanced customizations
2021-07-06 13:46:34 +02:00
Mathias Åhsberg b055ef88aa Add extension points for the LDAP processor for modifying group and user entities
Signed-off-by: Mathias Åhsberg <mathias.ahsberg@resurs.se>
2021-07-06 10:00:04 +00:00
Ben Lambert a8366759a3 Merge pull request #6313 from backstage/orkohunter/document-url-reader
docs: Document how URL Readers work and how to write a new one
2021-07-05 18:10:37 +02:00
Himanshu Mishra 19b459d2ba move url reader docs to plugins -> backend apis
Signed-off-by: Himanshu Mishra <himanshu@orkohunter.net>
2021-07-05 14:46:04 +02:00
Himanshu Mishra 918e2be318 docs: Add an example code block for debugging new url reader
Signed-off-by: Himanshu Mishra <himanshu@orkohunter.net>
2021-07-05 10:42:56 +02:00
Himanshu Mishra 9813f6c2c7 document how to add a new url reader (oss vs private)
and update section title

Signed-off-by: Himanshu Mishra <himanshu@orkohunter.net>
2021-07-05 10:21:31 +02:00
Crevil 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
Himanshu Mishra 7edef795a3 docs: Add a note about readUrl with read
Signed-off-by: Himanshu Mishra <himanshu@orkohunter.net>
2021-07-02 16:00:56 +02:00
Himanshu Mishra ce33886913 docs: fix vale spelling errors
Signed-off-by: Himanshu Mishra <himanshu@orkohunter.net>
2021-07-02 15:26:37 +02:00
Himanshu Mishra 4d2528ad4a docs: Document URL Reader
Concept
Interface
Using inside a plugin
Writing a new one

Signed-off-by: Himanshu Mishra <himanshu@orkohunter.net>
2021-07-02 15:22:17 +02:00
Himanshu Mishra 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
michael.rode aba2a907da Keep line that states why we should copy the repo skeleton first
Signed-off-by: michael.rode <michael.rode@rigup.com>
2021-07-01 00:18:41 -05:00
michael.rode 5de27b842f Update Docker host build documentation with updated default Dockerfile
Signed-off-by: michael.rode <michael.rode@rigup.com>
2021-06-30 23:53:16 -05:00
Fredrik Adelöw 4666577b53 Merge pull request #6141 from backstage/software-catalog-rename
Docs: Update references to "service catalog"
2021-06-28 13:47:16 +02:00
Fredrik Adelöw 257a55f3dc Merge pull request #6116 from goober/feature/extract-ldap-processor
Extract LdapOrgReaderProcessor into a separate package
2021-06-28 13:17:43 +02:00
Mathias Åhsberg 8e533f92c9 Extract LdapOrgReaderProcessor into a separate package
Signed-off-by: Mathias Åhsberg <mathias.ahsberg@resurs.se>
2021-06-28 10:04:24 +00:00
Fredrik Adelöw 31e4c48afc Merge pull request #6197 from backstage/rugvip/adrup
docs/adr011: add backend module naming pattern
2021-06-24 16:48:28 +02:00
Patrik Oldsberg bef43396ab docs/adr011: add backend module naming pattern
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2021-06-24 15:26:21 +02:00
Patrik Oldsberg 642cec7ac7 docs: remove references to @backstage/core
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2021-06-24 12:50:40 +02:00
Patrik Oldsberg c7126e7a86 docs,workflows: remove or update references to packages/core(-api)
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2021-06-24 12:50:40 +02:00
Patrik Oldsberg e6fc64756c Merge pull request #6138 from backstage/rugvip/migraine
docs: add tutorial for how to migrate away from @backstage/core
2021-06-24 12:49:52 +02:00
Ben Lambert fa67d01e95 Merge pull request #6013 from tudi2d/4782-forward-unhandled-errors
Catch unhandled promise rejections & forward them to the ErrorApi
2021-06-22 15:56:21 +02:00
Philipp Hugenroth de77f03f01 Adjust docs & parameters toto fit the API
Signed-off-by: Philipp Hugenroth <philipph@spotify.com>
2021-06-22 12:57:08 +02:00
Patrik Oldsberg c20b0bc2f2 Merge branch 'rugvip/mod' into rugvip/migraine 2021-06-22 11:44:38 +02:00
Patrik Oldsberg 3868f05d01 Merge pull request #6107 from backstage/mob/rearrange-docs
docs: move away from top-level support and glossary sections
2021-06-21 21:17:02 +02:00
Patrik Oldsberg 594444d0e0 docs: add tutorial for how to migrate away from @backstage/core
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2021-06-21 18:00:02 +02:00
Joe Porpeglia 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
Ben Lambert 809bcd396b Merge pull request #6122 from minnsoe/docs/add-db-docs-into-menu
Add db tutorial docs into menu and add privileges sub-section
2021-06-21 14:07:18 +02:00
Fredrik Adelöw 4045eaab95 Merge pull request #6119 from backstage/freben/copyright
Update copyright headers
2021-06-21 09:11:49 +02:00
Ben Lambert 347cec23fe Merge pull request #6120 from angeliski/improve-plugin-creation-workflow
feat: update plugin path to match same behavior in the main app
2021-06-21 08:56:49 +02:00
Minn Soe 3b52d79e70 docs: add sub-section on database privileges
Signed-off-by: Minn Soe <contributions@minn.io>
2021-06-18 22:50:40 +01:00
Rogerio Angeliski 953a7e66f9 feat: update plugin path to match same behavior in the main app
resolves #6108

Signed-off-by: Rogerio Angeliski <angeliski@hotmail.com>
2021-06-18 18:08:56 -03:00
Fredrik Adelöw a88073c29a Update copyright headers
Signed-off-by: Fredrik Adelöw <freben@gmail.com>
2021-06-18 20:26:42 +02:00
Brent Sharrow 64ebeb6026 Update code block in quickstart-app-plugin tutorial to use named import.
Signed-off-by: Brent Sharrow <bsharrow4@gmail.com>
2021-06-18 11:45:59 -05:00
Patrik Oldsberg e167019158 docs: move project structure to getting started
Co-authored-by: Fredrik Adelöw <freben@gmail.com>
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2021-06-18 11:37:45 +02:00
Patrik Oldsberg f3ece9ca0f docs: move glossary to overview
Co-authored-by: Fredrik Adelöw <freben@gmail.com>
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2021-06-18 11:34:52 +02:00
Patrik Oldsberg 325c7cd863 docs: move support in under overview
Co-authored-by: Fredrik Adelöw <freben@gmail.com>
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2021-06-18 11:29:25 +02:00
Oliver Sand 160181779b Add docs to microsite
Closes #4627

Signed-off-by: Oliver Sand <oliver.sand@sda-se.com>
2021-06-18 10:27:48 +02:00
Ben Lambert 79a5fc65a8 Merge pull request #4532 from backstage/rugvip/authin
auth-backend: implement sign-in resolver and profile transform for google provider
2021-06-17 15:33:13 +02:00
Ben Lambert 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
Patrik Oldsberg e3d31b3815 cli: disable GitHub App webhook by default
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2021-06-17 13:26:11 +02:00
Eric Peterson 07e449f75d Merge pull request #6065 from Dorn-/patch-2
fix: typo in openStackSwift credentials username
2021-06-17 09:46:50 +02:00
Patrik Oldsberg 4aac63d17c Merge pull request #6074 from lunarway/docs/config-visibility
Add example of visibility of config values
2021-06-17 09:33:08 +02:00
Crevil 23ad991a17 Add example of visibility of config values
Emphasize how to set config visibility in the docs with an example.

Signed-off-by: Crevil <bjoern.soerensen@gmail.com>
2021-06-17 09:20:45 +02:00
Dorn- 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
Bryan Lam 81ec239bb1 Fix backend-plugin document typo
Signed-off-by: Bryan Lam <bryan.s.lam@gmail.com>
2021-06-16 23:24:38 -07:00
blam c41bb50f94 chore: tidy up docs again
Signed-off-by: blam <ben@blam.sh>
2021-06-16 22:03:51 +02:00
blam 8061d1eb9e docs: rework the documentation to make the example a little simpler
Signed-off-by: blam <ben@blam.sh>

Co-authored-by: Fredrik Adelöw <freben@users.noreply.github.com>
Co-authored-by: Johan Haals <johan.haals@gmail.com>
Co-authored-by: Patrik Oldsberg <poldsberg@gmail.com>
2021-06-16 11:40:24 +02:00
blam ca60400ebe chore: update documentation a little bit
Signed-off-by: blam <ben@blam.sh>

Co-authored-by: Fredrik Adelöw <freben@users.noreply.github.com>
Co-authored-by: Johan Haals <johan.haals@gmail.com>
Co-authored-by: Patrik Oldsberg <poldsberg@gmail.com>
2021-06-16 11:08:07 +02:00
Tim Hansen 785a42f802 Move installation instructions to READMEs
Signed-off-by: Tim Hansen <timbonicus@gmail.com>
2021-06-15 15:00:15 -06:00