Commit Graph

2222 Commits

Author SHA1 Message Date
Vincenzo Scamporlino d0ac302c0f Merge pull request #11017 from backstage/permission-docs
Permission framework documentation
2022-05-02 17:29:07 +02:00
Patrik Oldsberg d768deeac2 docs/auth/troubleshooting: add general troubleshooting section
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2022-05-02 13:04:36 +02:00
Patrik Oldsberg df6701a5d8 docs/auth/troubleshooting: add sections for origin and user not found errors
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2022-05-02 12:18:43 +02:00
Patrik Oldsberg cce23c31fb docs/auth/troubleshooting: add section for misconfigured auth providers
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2022-05-02 12:06:03 +02:00
Patrik Oldsberg 5caff90bff docs: initial auth troubleshooting docs
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2022-05-02 11:56:32 +02:00
Joe Porpeglia b706a8d728 Add original note stating that permissions are already exported for the this tutorial
Signed-off-by: Joe Porpeglia <josephp@spotify.com>
2022-04-29 11:05:04 +01:00
Joe Porpeglia d039fb44a7 Add documentation about package api conventions for permissions
Signed-off-by: Joe Porpeglia <josephp@spotify.com>
2022-04-29 11:05:04 +01:00
Joe Porpeglia 1cbab91f6d Add note on cookie-based authentication
Signed-off-by: Joe Porpeglia <josephp@spotify.com>
2022-04-29 11:05:04 +01:00
Vincenzo Scamporlino 172e5c58b6 Add todo-list plugins prefix notice
Signed-off-by: Vincenzo Scamporlino <me@vinzscam.dev>
2022-04-29 11:05:04 +01:00
Vincenzo Scamporlino d1912729c9 Improve todo-list clone script
Signed-off-by: Vincenzo Scamporlino <me@vinzscam.dev>
2022-04-29 11:05:04 +01:00
Vincenzo Scamporlino 7f484f4960 fix unused var
Signed-off-by: Vincenzo Scamporlino <me@vinzscam.dev>
2022-04-29 11:05:04 +01:00
Vincenzo Scamporlino 74c70f99d5 Move todo-list sourcecode to plugins
Signed-off-by: Vincenzo Scamporlino <me@vinzscam.dev>
2022-04-29 11:05:03 +01:00
Joon Park ad9df65b74 Remove obsolete permission docs
Signed-off-by: Joon Park <joonp@spotify.com>
2022-04-29 11:05:03 +01:00
Vincenzo Scamporlino 22e8b41c3c Fix spelling issues
Signed-off-by: Vincenzo Scamporlino <me@vinzscam.dev>
2022-04-29 11:05:03 +01:00
Joe Porpeglia 8ebddc16a0 Update docs/permission/plugin-authors/04-authorizing-access-to-paginated-data.md
Co-authored-by: Joon Park <joonp@spotify.com>
Signed-off-by: Joe Porpeglia <josephp@spotify.com>
2022-04-29 11:05:03 +01:00
Joe Porpeglia f70e9b5368 Sync permission docs with framework changes
Signed-off-by: Joe Porpeglia <josephp@spotify.com>
2022-04-29 11:05:03 +01:00
Joe Porpeglia 480dffcfef Remove conclusion section
Signed-off-by: Joe Porpeglia <josephp@spotify.com>
2022-04-29 11:05:03 +01:00
Joe Porpeglia 6bbe08d6b9 Add documentation for custom permission rules
Signed-off-by: Joe Porpeglia <josephp@spotify.com>
2022-04-29 11:05:03 +01:00
Joe Porpeglia b5b349b09d Copy updates
Signed-off-by: Joe Porpeglia <josephp@spotify.com>
2022-04-29 11:05:03 +01:00
Joe Porpeglia 6bc4d75d33 Fix capitalization
Signed-off-by: Joe Porpeglia <josephp@spotify.com>
2022-04-29 11:05:03 +01:00
Joon Park 56a8d3a603 Add todo-list-common
Signed-off-by: Joon Park <joonp@spotify.com>
2022-04-29 11:05:03 +01:00
Joon Park cad2ccf728 Update plugin author permission docs
Signed-off-by: Joon Park <joonp@spotify.com>
2022-04-29 11:05:03 +01:00
Joon Park e566ac0295 Update plugin author permission docs (#10782)
* Update plugin author permission docs

Signed-off-by: Joon Park <joonp@spotify.com>

* Reorder content

Signed-off-by: Joon Park <joonp@spotify.com>

* Reconcile diffs with most recent changes to permission-docs

Signed-off-by: Joon Park <joonp@spotify.com>
2022-04-29 11:05:03 +01:00
Joe Porpeglia be14c351ce Use isPermission helper in test policy for plugin authors
Signed-off-by: Joe Porpeglia <josephp@spotify.com>
2022-04-29 11:05:03 +01:00
Joe Porpeglia 5d48b2de65 Add note explaining outdated demo video
Signed-off-by: Joe Porpeglia <josephp@spotify.com>
2022-04-29 11:05:03 +01:00
Joe Porpeglia 11841576a9 Refactor writing-a-policy doc
Signed-off-by: Joe Porpeglia <josephp@spotify.com>
2022-04-29 11:05:03 +01:00
Joe Porpeglia 27aab498ec Update md file link
Signed-off-by: Joe Porpeglia <josephp@spotify.com>
2022-04-29 11:05:03 +01:00
Joe Porpeglia d617d4cef7 Fix diff
Signed-off-by: Joe Porpeglia <josephp@spotify.com>
2022-04-29 11:05:03 +01:00
Vincenzo Scamporlino efa4afc661 Permission tutorial: update to recent changes
Signed-off-by: Vincenzo Scamporlino <me@vinzscam.dev>
2022-04-29 11:05:03 +01:00
MT Lewis 74d59fc59b docs: simplify command used to populate permission tuturial code
Signed-off-by: MT Lewis <mtlewis@users.noreply.github.com>
2022-04-29 11:05:03 +01:00
MT Lewis c8b8424f11 docs: fix bad whitespace in permission tutorial
Signed-off-by: MT Lewis <mtlewis@users.noreply.github.com>
2022-04-29 11:05:03 +01:00
MT Lewis a5321a9c7a permission-docs: update tutorial with boolean operator support
Signed-off-by: MT Lewis <mtlewis@users.noreply.github.com>
2022-04-29 11:05:03 +01:00
MT Lewis ac976be7ee docs: tweak permission tutorial step 4
Signed-off-by: MT Lewis <mtlewis@users.noreply.github.com>
2022-04-29 11:05:02 +01:00
MT Lewis ddc965debe docs: tweak permission tutorial step 3
Signed-off-by: MT Lewis <mtlewis@users.noreply.github.com>
2022-04-29 11:05:02 +01:00
MT Lewis b3e49aae39 docs: tweak permission tutorial step 2
Signed-off-by: MT Lewis <mtlewis@users.noreply.github.com>
2022-04-29 11:05:02 +01:00
MT Lewis b7b63ad527 docs: adjust permission framework plugin author tutorial titles
Signed-off-by: MT Lewis <mtlewis@users.noreply.github.com>
2022-04-29 11:05:02 +01:00
MT Lewis 127740d85d docs: tweak structure of permission docs
Signed-off-by: MT Lewis <mtlewis@users.noreply.github.com>
2022-04-29 11:05:02 +01:00
Joon Park 53828d7e76 Policy docs for permission framework (#9910)
* Policy docs for permission framework

Signed-off-by: Joon Park <joonp@spotify.com>

* Clarifications and typo fixes

Signed-off-by: Joon Park <joonp@spotify.com>
2022-04-29 11:05:02 +01:00
Vincenzo Scamporlino 23fc22c6dd Permission framework docs for plugin authors (#9702)
* Permission framework docs: plugin adopters

Signed-off-by: Vincenzo Scamporlino <me@vinzscam.dev>

* Add item to sidebar

Signed-off-by: Vincenzo Scamporlino <me@vinzscam.dev>

* Update docs/permission/permission-framework-for-plugin-authors.md

Co-authored-by: MT Lewis <mtlewis@users.noreply.github.com>
Signed-off-by: Vincenzo Scamporlino <me@vinzscam.dev>

* Update docs/permission/permission-framework-for-plugin-authors.md

Co-authored-by: MT Lewis <mtlewis@users.noreply.github.com>
Signed-off-by: Vincenzo Scamporlino <me@vinzscam.dev>

* Update docs/permission/permission-framework-for-plugin-authors.md

Co-authored-by: MT Lewis <mtlewis@users.noreply.github.com>
Signed-off-by: Vincenzo Scamporlino <me@vinzscam.dev>

* Update docs/permission/permission-framework-for-plugin-authors.md

Co-authored-by: MT Lewis <mtlewis@users.noreply.github.com>
Signed-off-by: Vincenzo Scamporlino <me@vinzscam.dev>

* Update docs/permission/permission-framework-for-plugin-authors.md

Co-authored-by: MT Lewis <mtlewis@users.noreply.github.com>
Signed-off-by: Vincenzo Scamporlino <me@vinzscam.dev>

* Update docs/permission/permission-framework-for-plugin-authors.md

Co-authored-by: MT Lewis <mtlewis@users.noreply.github.com>
Signed-off-by: Vincenzo Scamporlino <me@vinzscam.dev>

* Update docs/permission/permission-framework-for-plugin-authors.md

Co-authored-by: MT Lewis <mtlewis@users.noreply.github.com>
Signed-off-by: Vincenzo Scamporlino <me@vinzscam.dev>

* Update docs/permission/permission-framework-for-plugin-authors.md

Co-authored-by: MT Lewis <mtlewis@users.noreply.github.com>
Signed-off-by: Vincenzo Scamporlino <me@vinzscam.dev>

* Update docs/permission/permission-framework-for-plugin-authors.md

Co-authored-by: MT Lewis <mtlewis@users.noreply.github.com>
Signed-off-by: Vincenzo Scamporlino <me@vinzscam.dev>

* Update docs/permission/permission-framework-for-plugin-authors.md

Co-authored-by: MT Lewis <mtlewis@users.noreply.github.com>
Signed-off-by: Vincenzo Scamporlino <me@vinzscam.dev>

* Apply suggestions from code review

Co-authored-by: MT Lewis <mtlewis@users.noreply.github.com>
Co-authored-by: Joon Park <joonp@spotify.com>
Signed-off-by: Vincenzo Scamporlino <me@vinzscam.dev>

* Apply suggestions from code review

Co-authored-by: MT Lewis <mtlewis@users.noreply.github.com>
Signed-off-by: Vincenzo Scamporlino <me@vinzscam.dev>

* Docs improvements

Signed-off-by: Vincenzo Scamporlino <me@vinzscam.dev>

* Add todo-list plugins

Signed-off-by: Vincenzo Scamporlino <me@vinzscam.dev>

* Refactor structure and minor changes

Signed-off-by: Vincenzo Scamporlino <me@vinzscam.dev>

* Fix links

Signed-off-by: Vincenzo Scamporlino <me@vinzscam.dev>

* Update docs/permission/plugin-authors/setup-for-the-tutorial.md

Co-authored-by: MT Lewis <mtlewis@users.noreply.github.com>
Signed-off-by: Vincenzo Scamporlino <me@vinzscam.dev>

* Apply suggestions from code review

Co-authored-by: MT Lewis <mtlewis@users.noreply.github.com>
Signed-off-by: Vincenzo Scamporlino <me@vinzscam.dev>

* minor tutorial fixes

Signed-off-by: Vincenzo Scamporlino <me@vinzscam.dev>

* Fully implement permission rule

Signed-off-by: Vincenzo Scamporlino <me@vinzscam.dev>

* Add todos for missing content

Signed-off-by: Vincenzo Scamporlino <me@vinzscam.dev>

* Improve minified script

Signed-off-by: Vincenzo Scamporlino <me@vinzscam.dev>

* More todos

Signed-off-by: Vincenzo Scamporlino <me@vinzscam.dev>

* Fix rules exports

Signed-off-by: Vincenzo Scamporlino <me@vinzscam.dev>

Co-authored-by: MT Lewis <mtlewis@users.noreply.github.com>
Co-authored-by: Joon Park <joonp@spotify.com>
2022-04-29 11:05:02 +01:00
Joe Porpeglia f6b2566411 Split section for conditional decisions
Signed-off-by: Joe Porpeglia <josephp@spotify.com>
2022-04-29 11:05:02 +01:00
Joe Porpeglia 8c248b8826 Copy updates
Signed-off-by: Joe Porpeglia <josephp@spotify.com>
Co-authored-by: Fredrik Adelöw <freben@gmail.com>
2022-04-29 11:05:02 +01:00
Joe Porpeglia 6658a82713 Add permission concepts docs
Signed-off-by: Joe Porpeglia <josephp@spotify.com>
2022-04-29 11:05:02 +01:00
Joon Park f26bcf41a0 Add getting started docs for permissions (for adopters) (#9810)
* Add getting started docs for permissions (for adopters)

Signed-off-by: Joon Park <joonp@spotify.com>

* Minor formatting and wording fixes

Signed-off-by: Joon Park <joonp@spotify.com>
2022-04-29 11:05:02 +01:00
Joon Park 8f216f89be Outline permission docs structure (#9485)
Signed-off-by: Joon Park <joonp@spotify.com>
2022-04-29 11:05:02 +01:00
Joon Park be21be4108 Permission framework docs overview (#9412)
* Permission framework docs overview

Signed-off-by: Joon Park <joonp@spotify.com>

* Address comments

Signed-off-by: Joon Park <joonp@spotify.com>
2022-04-29 11:05:02 +01:00
Patrik Oldsberg 4c332c1521 docs: fix link to vale config
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2022-04-27 19:01:57 +02:00
Patrik Oldsberg 4b83c98165 update docs mentioning vale
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2022-04-27 18:48:50 +02:00
Patrik Oldsberg 89bb53685c vale: prune accepted vocabulary
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2022-04-27 18:44:55 +02:00
Eric Peterson 147df53000 Merge pull request #11088 from backstage/techdocs/document-addons
[TechDocs] Initial Addon Documentation
2022-04-27 16:02:17 +02:00
Eric Peterson 64889b7706 Add an illustration of Addon locations.
Signed-off-by: Eric Peterson <ericpeterson@spotify.com>
2022-04-27 15:46:39 +02:00