Commit Graph

1276 Commits

Author SHA1 Message Date
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
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
Patrik Oldsberg 05c98f1f79 Merge branch 'master' into add-support-for-plugin-specific-db 2021-06-15 17:49:50 +02:00
Himanshu Mishra db1d558411 auth-backend: always use full user/group entity refs
Signed-off-by: Himanshu Mishra <himanshu@orkohunter.net>
2021-06-15 13:12:39 +02:00
Himanshu Mishra 7dd84f37f0 Apply suggestions from code review
Signed-off-by: Himanshu Mishra <himanshu@orkohunter.net>

Co-authored-by: Fredrik Adelöw <freben@gmail.com>
Co-authored-by: Patrik Oldsberg <poldsberg@gmail.com>
2021-06-15 13:12:39 +02:00
Himanshu Mishra 46c52d0aca docs: fix doc reference links
Signed-off-by: Himanshu Mishra <himanshu@orkohunter.net>
2021-06-15 13:12:39 +02:00
Himanshu Mishra a0949d5892 docs: Add docs explaining sign-in resolvers and profile transform
Signed-off-by: Himanshu Mishra <himanshu@orkohunter.net>
2021-06-15 13:12:39 +02:00
Fredrik Adelöw 2b13540015 Some quick docs on how to interface with databases from backend plugins
Signed-off-by: Fredrik Adelöw <freben@gmail.com>
2021-06-10 19:24:48 +02:00
Minn Soe 5a3ce34072 refactor: migrate from deprecated database manager
Changes:
- Swaps out `SingleConnectionDatabaseManager` to `DatabaseManager`
  across the repo.
- Updates `backend-test-utils` to generate test plugin names prefixed
  with db to satisfy plugin naming constraint, e.g. 0 becomes db0.

Signed-off-by: Minn Soe <contributions@minn.io>
2021-06-10 11:14:40 +01:00
Minn Soe 4d17ececc5 docs: fix typo in db manager changeset and clarify
Signed-off-by: Minn Soe <contributions@minn.io>
2021-06-10 11:14:40 +01:00
Minn Soe 772dbdb511 feat: add database manager with per plugin config
This commit introduces:
- a new backwards compatible database manager which allows the end-user
  to set global and per plugin database configuration.
- an early iteration of a database connector interface.
- provides helper functions for each of the database connectors to
  meet the new interface.

Signed-off-by: Minn Soe <contributions@minn.io>
2021-06-10 11:14:40 +01:00
Eric Peterson 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
Eric Peterson 5c9c34dee9 Merge pull request #5927 from backstage/iameap/search-alpha-release
[Search] Initial, Alpha Release
2021-06-09 19:21:15 +02:00
Fredrik Adelöw 363b0b87ea Merge pull request #5925 from xShteff/master
docs: added example dockerfiles for techdocs and templating
2021-06-09 15:37:25 +02:00
Fredrik Adelöw e71d0002ab fix prettier
Signed-off-by: Fredrik Adelöw <freben@gmail.com>
2021-06-09 14:51:28 +02:00
Deepak Bhardwaj d07e874d06 Small correction
Just a small grammar correction

Signed-off-by: Fredrik Adelöw <freben@gmail.com>
2021-06-08 22:22:40 +02:00
Fredrik Adelöw 28fc26ddf4 Merge pull request #5849 from SDA-SE/feat/scaffolder-conditional
Conditional scaffolder steps
2021-06-08 14:25:49 +02:00
Fredrik Adelöw d06e212903 prettier
Signed-off-by: Fredrik Adelöw <freben@gmail.com>
2021-06-07 14:39:34 +02:00
HelenGreul 1496103b82 re-pointing live demo links to demo.backstage.io
Signed-off-by: Helen Greul <heleng@spotify.com>
2021-06-07 13:57:38 +02:00
Fredrik Adelöw a78c7dd04b Merge pull request #5890 from premisedata/template_docs
[Docs] Update writing templates to include arrays + json input step
2021-06-07 10:19:21 +02:00
Emma Indal f3a9a063a6 docs fixups
Signed-off-by: Emma Indal <emma.indahl@gmail.com>
2021-06-06 22:04:29 +02:00
Emma Indal 50873903fb Add Lunr as example
Signed-off-by: Emma Indal <emma.indahl@gmail.com>
2021-06-06 22:02:09 +02:00
Eric Peterson 3bc581732c More iteration on Search Feature documentation.
Signed-off-by: Eric Peterson <ericpeterson@spotify.com>
2021-06-06 12:52:43 +02:00
Alin Stefan Olaru 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
Eric Peterson d2a75ce613 v1/v2/v3 -> alpha/beta/ga
Signed-off-by: Eric Peterson <ericpeterson@spotify.com>
2021-06-04 18:40:46 +02:00
Oliver Sand 09fdc24802 Improve documentation
Signed-off-by: Oliver Sand <oliver.sand@sda-se.com>
2021-06-04 16:30:33 +02:00
Oliver Sand af06c6a782 Some small fixes
Signed-off-by: Oliver Sand <oliver.sand@sda-se.com>
2021-06-04 16:30:32 +02:00
Himanshu Mishra 0cf2ddbbff docs: Link sqlite to postgres switch tutorial in create app page
Signed-off-by: Himanshu Mishra <himanshu@orkohunter.net>
2021-06-04 11:37:41 +02:00