6997 Commits

Author SHA1 Message Date
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
Eric Peterson 2f0c7b3ed5 Initial documentation for TechDocs Addons.
Signed-off-by: Eric Peterson <ericpeterson@spotify.com>
2022-04-27 12:53:14 +02:00
Fredrik Adelöw 7cd399ede0 most of these casts are apparently no longer necessary
Signed-off-by: Fredrik Adelöw <freben@gmail.com>
2022-04-27 11:01:31 +02:00
Patrik Oldsberg 9dc86a7bdc Merge pull request #11091 from backstage/rugvip/auth-doc-tweaks
docs: add auth doc section to explain sign-in without catalog
2022-04-27 10:03:45 +02:00
Patrik Oldsberg 17ae6852ee docs: add auth doc section to explain sign-in without catalog
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2022-04-26 19:34:11 +02:00
Ben Lambert 1cb9cec16b Merge pull request #11085 from backstage/blam/discovery/docs
docs: some smaller docs changes for github discovery
2022-04-26 15:50:54 +02:00
Patrik Oldsberg d06fbf7bb0 Merge pull request #11071 from backstage/rugvip/auth-docs
docs,core-plugin-api: update auth intro docs + mark auth APIs stable
2022-04-26 15:25:23 +02:00
blam 264a189389 docs: reworking some more things
t
Signed-off-by: blam <ben@blam.sh>
2022-04-26 14:48:24 +02:00
github-actions[bot] 1bff70d602 Version Packages (next) 2022-04-26 12:22:43 +00:00
Ben Lambert f56897a87f Merge pull request #11069 from backstage/blam/smol-twekas
Adding some relevant documentation links to `app-config.yaml`
2022-04-26 11:40:45 +02:00
blam 92b1bb4057 docs: rework the wording a ltitle bit
Signed-off-by: blam <ben@blam.sh>
2022-04-26 10:38:52 +02:00
Patrik Oldsberg 4e80f266ce docs: update auth introduction docs + inline usage docs
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2022-04-25 15:45:40 +02:00
blam bb6eab19c6 chore: some small minor changes here about generating a token
Signed-off-by: blam <ben@blam.sh>
2022-04-25 14:56:01 +02:00
Johan Haals 1934e70c5c docs: Remove confusing wording from k8 plugin install
Signed-off-by: Johan Haals <johan.haals@gmail.com>
2022-04-25 10:50:09 +02:00
Patrik Oldsberg 6aea66b400 Merge pull request #11029 from backstage/rugvip/auth-docs
auth/docs: Update user identity and sign-in resolver docs
2022-04-22 17:07:53 +02:00
Niklas Aronsson 6673babab9 GerritUrlReader: Implemented "readTree"
"readTree" has been implemented for the "GerritUrlReader". Gerrit have
a REST API's to download repo contents but there are a number of
limitations that makes it unusable.

This implementation works as follows:
* The project and branch is parsed from the url.
* The current revision is fetched from the Gerrit REST API.
* The revision string is used as "etag".
* If the etag has changed a temporary directory is created.
* The project is cloned to the temporary directory.
* The cloned content is read into a "Readable Stream".
* The temporary directory is removed.
* "readTree" returns a response using "fromTarArchive" as read from the
  temporary directory.

Also added an option to specify the base "cloneUrl" has been added to the
gerrit integration config.

Signed-off-by: Niklas Aronsson <niklasar@axis.com>
2022-04-22 14:52:02 +02:00
Patrik Oldsberg 38e08c2b7e auth/docs: Update user identity and sign-in resolver docs
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2022-04-22 14:28:49 +02:00
Johan Haals 32791a2588 Merge pull request #10972 from lovie/patch-1
Updated documentation to rename plugin
2022-04-22 08:45:51 +02:00
Johan Haals 3feeeef3b6 Merge pull request #10669 from anicke/gerrit-entity-provider
New plugin: "plugin-catalog-backend-module-gerrit"
2022-04-21 14:20:23 +02:00
Johan Haals 34e7d8af0d Merge pull request #10736 from Bonial-International-GmbH/PJ_bitbucket_split
Split bitbucket support into bitbucketCloud and bitbucketServer
2022-04-21 10:37:31 +02:00
Lovie 86b0909e25 Updated documentation to rename plugin
Documentation was not up to date with master codebase where plugin has been renamed to scaffolderPlugin

Signed-off-by: Lovie <lovie.minhas@gmail.com>
2022-04-21 09:19:13 +01:00
Niklas Aronsson 566407bf8a New plugin: "plugin-catalog-backend-module-gerrit"
The "plugin-catalog-backend-module-gerrit" exports an entity
provider for discovering catalog entities from Gerrit
repositories. The provider uses the "List Projects" API in Gerrit
to get a list of repositories and will automatically ingest all
"catalog-info.yaml" files stored in the root of the matching
projects.

Also added the "getGerritProjectsApiUrl" function to the Gerrit
integration. This returns the url to the "List Projects" API for
a given integration.

Signed-off-by: Niklas Aronsson <niklasar@axis.com>
2022-04-21 07:33:40 +02:00
Matthew Clarke b9f7ffb162 feat: add gke cluster locator resource label filtering (#10908)
* feat: add gke cluster locator resource label filtering

Signed-off-by: Matthew Clarke <mclarke@spotify.com>

* test: add gke label filter tests

Signed-off-by: Matthew Clarke <mclarke@spotify.com>

* docs: add gke label filtering changeset

Signed-off-by: Matthew Clarke <mclarke@spotify.com>

* style: prettier

Signed-off-by: Matthew Clarke <mclarke@spotify.com>

* docs: add gke label matching docs

Signed-off-by: Matthew Clarke <mclarke@spotify.com>

* style: prettier

Signed-off-by: Matthew Clarke <mclarke@spotify.com>
2022-04-20 13:36:54 -04:00
Patrik Oldsberg 40429e9695 Merge pull request #10864 from sharadpattanshetti/sharadp/knexpoolconfigoverride
Added docs for knex pool config
2022-04-20 19:16:34 +02:00
Johan Haals ccd052d230 chore: Change title to GitHub Apps
Signed-off-by: Johan Haals <johan.haals@gmail.com>
2022-04-20 13:20:12 +02:00
Johan Haals 5a045a61f9 docs: Restructure Github apps documentation
Signed-off-by: Johan Haals <johan.haals@gmail.com>
2022-04-20 11:11:55 +02:00