From fd563915ebc5c5831f7884b27fe46e3d5b9e3046 Mon Sep 17 00:00:00 2001 From: Aramis Sennyey <34432188+sennyeya@users.noreply.github.com> Date: Mon, 29 Jan 2024 14:34:41 -0500 Subject: [PATCH] Apply suggestions from code review MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Fredrik Adelöw Signed-off-by: Aramis Sennyey <34432188+sennyeya@users.noreply.github.com> --- docs/permissions/concepts.md | 2 +- docs/references/glossary.md | 10 +++++----- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/permissions/concepts.md b/docs/permissions/concepts.md index c3c32601df..556d752c52 100644 --- a/docs/permissions/concepts.md +++ b/docs/permissions/concepts.md @@ -16,4 +16,4 @@ In many cases, a permission represents a user's interaction with another object. See [Conditional decisions](../references/glossary.md#conditional-decisions). -A good example would be the catalog plugin's "has annotation" rule needs to know what annotation to look for on a given entity. The permission framework would respond to a request by the catalog plugin in this case with a condition decision. The catalog plugin would then need to correctly filter for entities matching the "has annotations" condition. This conditional behavior avoids coupling between policies and resource schemas, and allows plugins to evaluate complex rules in an efficient way. For example, a plugin may convert a conditional decision to a database query instead of loading and filtering objects in memory. +A good example would be the catalog plugin's "has annotation" rule which needs to know what annotation to look for on a given entity. The permission framework would respond to a request by the catalog plugin in this case with a condition decision. The catalog plugin would then need to correctly filter for entities matching the "has annotations" condition. This conditional behavior avoids coupling between policies and resource schemas, and allows plugins to evaluate complex rules in an efficient way. For example, a plugin may convert a conditional decision to a database query instead of loading and filtering objects in memory. diff --git a/docs/references/glossary.md b/docs/references/glossary.md index b82b2da064..abbb8ce5ef 100644 --- a/docs/references/glossary.md +++ b/docs/references/glossary.md @@ -183,7 +183,7 @@ Refers to: OAuth 2.0, a standard protocol for authorization. See [oauth.net/2/]( ## OpenID Connect -A layer on top of [OAuth](#oauth) which standardises authentication. See [en.wikipedia.org/wiki/OpenID_Connect](https://en.wikipedia.org/wiki/OpenID_Connect). +A layer on top of [OAuth](#oauth) which standardises authentication. See [the Wikipedia article](https://en.wikipedia.org/wiki/OpenID_Connect) for more details. ## OSS @@ -195,7 +195,7 @@ A package in the Node.js ecosystem, often published to a [package registry](#pac ## Package Registry -A service that hosts packages. The most prominent example is [NPM](https://www.npmjs.com/). +A service that hosts [packages](#package). The most prominent example is [NPM](https://www.npmjs.com/). ## Package Role @@ -247,7 +247,7 @@ An abstraction layer between a search engine and the [Backstage Search](#search) ## Refresh Token -A string that an [OAuth](#oauth) client can use to get a new access token. +A special token that an [OAuth](#oauth) client can use to get a new [access token](#access-token) when the latter expires. https://oauth.net/2/refresh-tokens/ @@ -263,7 +263,7 @@ See [User Role](#User-Role). ## Scope -A string that describes a certain type of access that can be granted to a user using OAuth. +A string that describes a certain type of access that can be granted to a user using OAuth, usually in conjunction with [access tokens](#access-token). ## Search @@ -307,4 +307,4 @@ A purpose for which a [user role](#User-Role) interacts with Backstage. Related ## User Role -A class of Backspace user for purposes of analyzing [use cases](#use-case). One of: evaluator; administrator; developer; integrator; and contributor. +A class of Backstage user for purposes of analyzing [use cases](#use-case). One of: evaluator; administrator; developer; integrator; and contributor.