Commit Graph

51 Commits

Author SHA1 Message Date
Fredrik Adelöw 9aac2b0d36 move cwd as the first argument to yarn
Signed-off-by: Fredrik Adelöw <freben@gmail.com>
2024-02-04 20:13:00 +01:00
Fredrik Adelöw 22ddbbb259 Merge pull request #22542 from sennyeya/documentation/glossary
docs: add a central glossary
2024-02-03 11:33:56 +01:00
Aramis ddfeada980 remove lengthy definitions
Signed-off-by: Aramis <sennyeyaramis@gmail.com>
2024-01-30 22:43:23 -05:00
Aramis 4944f29f2c update documentation and add a simple guide.
Signed-off-by: Aramis <sennyeyaramis@gmail.com>
2024-01-30 22:28:02 -05:00
Aramis Sennyey fd563915eb Apply suggestions from code review
Co-authored-by: Fredrik Adelöw <freben@gmail.com>
Signed-off-by: Aramis Sennyey <34432188+sennyeya@users.noreply.github.com>
2024-01-29 14:34:41 -05:00
npiyush97 ad9768228d ran lighthouse scripts over docs and releases find these
Signed-off-by: npiyush97 <npiyush35@gmail.com>
2024-01-28 18:27:44 +05:30
Aramis a560bfd7a3 fix missing extension
Signed-off-by: Aramis <sennyeyaramis@gmail.com>
2024-01-26 10:39:36 -05:00
Aramis 2e440d4723 docs: add a central glossary
Signed-off-by: Aramis <sennyeyaramis@gmail.com>
2024-01-25 23:42:14 -05:00
stanleyn 93c39784b9 add ellipsis
Signed-off-by: stanleyn <stanleyn@spotify.com>
2023-12-22 15:18:30 +00:00
stanleyn f8119bdf53 fix spelling
Signed-off-by: stanleyn <stanleyn@spotify.com>
2023-12-22 15:16:53 +00:00
stanleyn 83ddafc5a9 Add missing imports, add zod install, fix import
Signed-off-by: stanleyn <stanleyn@spotify.com>
2023-12-22 15:08:56 +00:00
stanleyn 0f97e22a23 Update file examples, routing
Signed-off-by: stanleyn <stanleyn@spotify.com>
2023-12-21 17:16:54 +00:00
stanleyn 620b944314 Update custom permission rule naming and files
Signed-off-by: stanleyn <stanleyn@spotify.com>
2023-12-21 17:16:54 +00:00
stanleyn 3e56dee756 Add file extension
Signed-off-by: stanleyn <stanleyn@spotify.com>
2023-11-24 14:19:04 +00:00
stanleyn 06af5a617c Update custom permission rules documentation
Signed-off-by: stanleyn <stanleyn@spotify.com>
2023-11-24 13:01:01 +00:00
Patrik Oldsberg 8613ba3928 plugins: remove usages of --experimental-type-build
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2023-10-22 11:49:44 +02:00
Sergey Shevchenko 56575be2a2 docs: Add notes about backstage root dir
Signed-off-by: Sergey Shevchenko <sergeyshevchdevelop@gmail.com>
2023-05-18 10:58:17 +03:00
Joon Park 82148bbe09 Fix incorrect diffs in plugin author permission docs (#17439)
Signed-off-by: Joon Park <joonp@spotify.com>
2023-05-04 11:35:12 +02:00
Joon Park d669ea611f Update plugin author permission docs to match correct usage of createPermissionIntegrationRouter
Signed-off-by: Joon Park <joonp@spotify.com>
2023-04-14 15:26:16 +01:00
Claire Casey ef63b7b207 remove zod version from docs
Signed-off-by: Claire Casey <ccasey@spotify.com>
2023-04-03 11:31:30 -04:00
Claire Casey c1db0317f6 specify zod version in workspace install command
Signed-off-by: Claire Casey <ccasey@spotify.com>
2023-03-20 10:45:24 -07:00
Claire Casey 21e9c235b9 add zod as dependency to specify version
Signed-off-by: Claire Casey <ccasey@spotify.com>
2023-03-10 16:25:47 -05:00
Paul Schultz 040b54f7e5 clean up formatting
Signed-off-by: Paul Schultz <pschultz@pobox.com>
2023-03-08 10:13:38 -06:00
Paul Schultz 34fe6c9246 Merge branch 'master' into update-codeblocks 2023-03-08 10:07:11 -06:00
Paul Schultz 9c95f91c0a Add titles to codeblocks and switch from diff codeblock to language codeblock
Signed-off-by: Paul Schultz <pschultz@pobox.com>
2023-03-01 13:30:38 -06:00
Vincenzo Scamporlino 8252800c9a Remove references to backend-to-backend docs
Signed-off-by: Vincenzo Scamporlino <vincenzos@spotify.com>
2023-02-27 16:18:44 +01:00
Guanghui Li 542da6ba11 Fixed IdentifyClient import inconsistency in permissions tutorial
Signed-off-by: Guanghui Li <liguanghui.cs@gmail.com>
2023-02-17 00:13:21 -06:00
Jan Van Bruggen c51efce2a0 Update docs to always use yarn add --cwd for app & backend
Some commands currently error, and others are simply formatted inconsistently.
This format seems to work and be the most popular/common,
so I applied it to all similar occurrences.

Signed-off-by: Jan Van Bruggen <JanVB@verily.com>
2023-02-13 09:40:20 -07:00
Waldir Montoya e991a3bf99 Merge branch 'backstage:master' into master 2023-02-06 19:39:30 -05:00
Patrik Oldsberg 0ff03319be backend-plugin-api: switch createBackendPlugin id -> pluginId
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2023-02-06 17:49:57 +01:00
MT Lewis 812ffcc292 docs: miscellaneous permission tutorial step 5 fixes
Signed-off-by: MT Lewis <mtlewis@users.noreply.github.com>
2023-02-03 13:07:13 +00:00
MT Lewis f3bf8fea24 docs: miscellaneous permission tutorial step 4 fixes
Signed-off-by: MT Lewis <mtlewis@users.noreply.github.com>
2023-02-03 13:07:08 +00:00
MT Lewis ce2c9ac363 docs: miscellaneous permission tutorial step 3 fixes
Signed-off-by: MT Lewis <mtlewis@users.noreply.github.com>
2023-02-03 13:07:05 +00:00
MT Lewis 8d6d1fb789 docs: miscellaneous permission tutorial step 2 fixes
Signed-off-by: MT Lewis <mtlewis@users.noreply.github.com>
2023-02-03 13:07:01 +00:00
MT Lewis c578ab6583 docs: adjust code block type in permission tutorial step 1
Signed-off-by: MT Lewis <mtlewis@users.noreply.github.com>
2023-02-03 13:06:24 +00:00
Waldir Montoya 560fd3e6ae Update the ecosystem model section of the docs
Signed-off-by: Waldir Montoya <wmontoya@vmware.com>
2023-02-02 21:19:02 -05:00
Vincenzo Scamporlino e0d354b454 docs: fix permissions tutorial setup script
Signed-off-by: Vincenzo Scamporlino <vincenzos@spotify.com>
2023-02-01 15:28:47 +01:00
Andre Wanlin 093ef4c5b3 Improved formatting and content
Signed-off-by: Andre Wanlin <67169551+awanlin@users.noreply.github.com>
2022-10-24 08:48:24 -05:00
Andre Wanlin 445460e2d1 Updates to the To Do List permission tutorial
Signed-off-by: Andre Wanlin <67169551+awanlin@users.noreply.github.com>
2022-10-24 08:37:22 -05:00
Fredrik Adelöw 8b7d96e6b9 small correction in the permissions docs
Signed-off-by: Fredrik Adelöw <freben@gmail.com>
2022-10-24 09:19:17 +02:00
Harry Hogg b939494552 Fixed import in docs
Signed-off-by: Harry Hogg <hhogg@spotify.com>
2022-10-18 13:32:48 +01:00
Harry Hogg 24fb30fdb3 Updated permissions documentation to match paramsSchema changes
Signed-off-by: Harry Hogg <hhogg@spotify.com>
2022-10-18 13:00:27 +01:00
MT Lewis e17332b291 docs: fix toQuery method in custom rules permissions docs
Signed-off-by: MT Lewis <mtlewis@users.noreply.github.com>
2022-10-10 15:35:16 +01:00
MT Lewis 7506c95e94 docs: fix incorrect import in frontend permission integration docs (#13816)
Signed-off-by: MT Lewis <mtlewis@users.noreply.github.com>

Signed-off-by: MT Lewis <mtlewis@users.noreply.github.com>
2022-09-23 13:05:55 +01:00
Joon Park 6c027cdab2 Frontend authorization docs for plugin authors (#11034)
* Frontend authorization docs for plugin authors

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

* Wording changes

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

* Clarify name of example create permission variable

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

* Refactor todo list frontend code to reduce diff

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

* API reports

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

Signed-off-by: Joon Park <joonp@spotify.com>
2022-09-22 14:06:23 +01:00
Joon Park ff08f1d14e Frontend permission docs for integrators (#11039)
* Frontend permission docs for integrators

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

* Update docs/permission/frontend-integration.md

Co-authored-by: Joe Porpeglia <josephp@spotify.com>
Signed-off-by: Joon Park <joonp@spotify.com>

Signed-off-by: Joon Park <joonp@spotify.com>
Co-authored-by: Joe Porpeglia <josephp@spotify.com>
2022-09-21 13:56:37 +01:00
Andre Wanlin 07fa501761 Minor updates to the Pemissions docs
Signed-off-by: Andre Wanlin <67169551+awanlin@users.noreply.github.com>
2022-09-12 15:12:50 -05:00
Brian Fletcher 2cbd533426 break identity client into an interface
The interface has changed a little instead of allowing the client to
parse out the authorization header, it takes the request object as is
to extract the identity from it how the implementation decides.

IdentityClient#authenticate is now deprecated, in favor of
IdentityApi#getIdentity.

I am leaving the IdentityClient in place deprecated so that plugins
that use this can migrate away from it.

Signed-off-by: Brian Fletcher <brian@roadie.io>
2022-07-08 16:56:23 +01:00
Vincenzo Scamporlino 477b6440b2 Fix export conditional utilities
Signed-off-by: Vincenzo Scamporlino <vincenzos@spotify.com>
2022-07-01 23:26:38 +02:00
Vincenzo Scamporlino 1807f6a503 Permission framework docs: fix condition exports
Signed-off-by: Vincenzo Scamporlino <vincenzos@spotify.com>
2022-07-01 10:52:54 +02:00