Commit Graph

56 Commits

Author SHA1 Message Date
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
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
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
Himanshu Mishra 0ed1f45660 Merge pull request #5782 from backstage/orkohunter/docs-auth-gitlab 2021-05-24 16:27:57 +02:00
Patrik Oldsberg 32925b0d00 docs: remove plugins from createApp examples + clarify app auth tutorial
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2021-05-23 19:37:52 +02:00
Himanshu Mishra 0b4c50cba8 docs: Update GitLab auth environment variable names
Sync with the names used in `app-config.yaml`

https://github.com/backstage/backstage/blob/f681f408d443fa75ed0de4ee0cde8de03357be72/app-config.yaml#L283-L286

Signed-off-by: Himanshu Mishra <himanshu@orkohunter.net>
2021-05-23 13:17:17 +02:00
Fredrik Adelöw d7b59889db Merge pull request #5277 from backstage/timbonicus/signinconfig
Export SignInConfig type
2021-04-15 18:40:24 +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
Tim Hansen 83a437b349 SignInConfig -> SignInProviderConfig
Signed-off-by: Tim Hansen <timbonicus@gmail.com>
2021-04-13 07:59:31 -06:00
Tim Hansen 6db797a67c Add OneLogin auth documentation
Signed-off-by: Tim Hansen <timbonicus@gmail.com>
2021-04-06 20:40:09 -06:00
Tim Hansen 0a0fa4dded No auto for you
Signed-off-by: Tim Hansen <timbonicus@gmail.com>
2021-04-06 12:05:47 -06:00
Tim Hansen e3190971e7 Update auth index to be more "getting started" focused
Signed-off-by: Tim Hansen <timbonicus@gmail.com>
2021-04-06 12:01:19 -06:00
Tim Hansen f5f61e659e Backticks
Signed-off-by: Tim Hansen <timbonicus@gmail.com>
2021-03-26 20:58:20 -06:00
Tim Hansen f07848c770 Add documentation for included auth providers
Signed-off-by: Tim Hansen <timbonicus@gmail.com>
2021-03-26 20:58:20 -06:00
Alan Crosswell 07bafa248e Add configurable OAuth 2.0 scopes
- Add oauth2 config for optional scopes
- Document oauth2 config keys
- Add OAuth2 to demo app list of identity providers
2021-02-09 14:50:20 -05:00
Patrik Oldsberg 23381386d6 docs: update auth docs to mention and prefer single-provider SignInPage 2021-01-28 19:25:58 +01:00
Fredrik Adelöw ffa36ff101 Merge pull request #3927 from adamdmharvey/doco-prettier-seo
docs: Align Docusaurus for fixed SEO output and "prettier" happiness
2021-01-12 21:42:53 +01:00
Adam Harvey 14466940f7 Single line metadata and prettier ignore 2021-01-05 13:42:31 -05:00
Joel Low 506679a5a2 Add basic documentation for the SAML auth provider 2020-12-30 07:12:43 +08:00
Patrik Oldsberg c9544afa01 scripts/verify-links: forbid relative links out of docs 2020-12-01 20:23:02 +01:00
Fredrik Adelöw 50eff1d003 auth-backend: add changeset that was missing (plus minor docs tweaks) (#3458) 2020-11-26 13:14:12 +01:00
Govind 202da8ab36 Allow application to register custom AuthProviderFactory. Refs #1984 (#3329)
* Allow application to register custom `AuthProviderFactory`. Refs #1984

* PR comments: Explicit exports

* Export `OAuth` specific types from the package

* Update documentation on how to use the interfaces

* Re-export from base `index.ts` as per ADR-004

* pass `providerId` as a parameter to `AuthFactory` instead of hardcoding

Co-authored-by: Govindarajan Nagarajan <govindarajan.nagarajan@zalando.de>
2020-11-26 11:27:00 +01:00
Patrik Oldsberg af141c0766 rewrite repo location urls 2020-11-03 11:03:49 +01:00
Adam Harvey a06164da24 Documentation editorial review (#3055)
* Fix case and link

* Align product/vendor case

* Reword for readability

* YAML Case

* Align product names

* Align product and acronym case

* Remove here link and product naming

* Align Node.js naming

* Align product names

* Fix wording
2020-10-23 08:01:07 +02:00
Patrik Oldsberg 6775deef9b update docs and examples to use shorter config secret syntax 2020-10-04 16:51:00 +02:00
Navaneeth Suresh e7686833fd docs: fix typos in the documentation (#2633) 2020-09-28 13:18:40 +02:00
Patrik Oldsberg 521728348d backend: change the default backend plugin mount point to /api 2020-09-23 09:39:47 +02:00
Patrik Oldsberg 92510f61bb docs: clarify role of identity and SignInPage 2020-09-21 20:51:37 +02:00
Ivan Shmidt b0656e47d9 Merge pull request #2489 from iamrajiv/issue_1994
Added description header field in backstage.io docs
2020-09-16 22:29:50 +02:00
Rajiv Singh 19550ef1fd Added PlantUML diagrams in backstage.io docs (#2413)
* added Sequence Diagram

* updated location for generated UML diagrams
2020-09-16 21:53:24 +02:00
Rajiv Ranjan Singh d833cd9fe8 added description header field 2020-09-16 22:14:28 +05:30
Rajiv Ranjan Singh 812da7539f added description header field 2020-09-16 21:56:32 +05:30
Rajiv Ranjan Singh def4032351 added description header field 2020-09-16 21:47:19 +05:30
Patrik Oldsberg 5a77294829 docs/auth: minor text fixes 2020-09-03 17:48:10 +02:00
Patrik Oldsberg c8785b9ee0 auth-backend: rename OAuthProvider to OAuthAdapter 2020-09-03 15:08:38 +02:00
Patrik Oldsberg fa32cee7ad docs/auth: update to reflect backend changes 2020-09-03 14:51:22 +02:00
Stefan Ålund a8edb19f61 [Docs] Various fixes (#2136)
* [Docs] Various fixes

* More fixes

* Fix ADRs

* Typo
2020-08-27 13:27:22 +02:00
Fredrik Adelöw 38e185b2be docs(auth-backend): some minor tweaks (#1989) 2020-08-18 15:50:43 +02:00
Govind 1aac6f1fb3 Add documentation explaining authentication in the backend (#1963)
* Add documentation explaining authentication in the backend

* Link newly added document to mkdocs and app documentation

Co-authored-by: Govindarajan Nagarajan <govindarajan.nagarajan@zalando.de>
2020-08-17 12:39:51 +02:00
Ivan Shmidt 0867d3dc30 feat: more docs to backstage.io 2020-08-12 12:06:14 +02:00
Patrik Oldsberg 3dd7fa7c3e docs: add links to api references 2020-07-19 14:27:35 +02:00
Stefan Ålund ce30c43d24 [Docs] Fix relative paths to code (#1662)
* [Docs] Fix relative paths to code

* Update create-a-plugin.md

* Link to existing plugins

* Update README.md

* Update README.md

* Review edits
2020-07-16 09:17:43 +02:00
Stefan Ålund f59dd3a073 [Docs] Fix broken links and more 2020-07-15 12:24:15 +02:00
Stefan Ålund 8ec6ed5170 Documentation skeleton (#1617)
* Documentation skeleton

* Added ADR list and more

* rm material theme

* Update mkdocs.yml

* Add docs TOC

* Work for plain MD and mkdocs

* Update mkdocs.yml

* Restructuring

* Added roadmap

* Add reference APIs

* move publishing
2020-07-15 08:57:25 +02:00