Skip to content

Commit b7230f5

Browse files
Capitalize section headers across documentation files
Standardized capitalization for section headers to improve consistency across documentation. This includes changes like converting "## On Windows using IIS hosting" to "## On Windows Using IIS Hosting" and similar adjustments for all other headers.
1 parent 716cb8c commit b7230f5

91 files changed

Lines changed: 288 additions & 274 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# docs.duendesoftware.com
22

33
---
4-
## Private branch notice
4+
## Private Branch Notice
55

66
This respository is a private clone of Duende docs.duendesoftware.com repository (it is not a GitHub fork).
77

@@ -61,7 +61,7 @@ There are two ways to restructure content:
6161
* Internal (move content around in the current structure)
6262
* External (move content outside the current structure)
6363

64-
### Internal restructuring
64+
### Internal Restructuring
6565

6666
When doing internal restructuring, move the page to its new location and then update its frontmatter
6767
to include the old location:
@@ -78,7 +78,7 @@ Page content goes here
7878

7979
This will generate the page at the new location, and put a redirect to it at the old location.
8080

81-
### External restructuring
81+
### External Restructuring
8282

8383
When moving a page outside the structure, or you need a redirect to another location altogether,
8484
edit the `astro.config.mjs` file and append a key/vaklue pair to the `redirects` property:

src/content/docs/accesstokenmanagement/advanced/DPoP.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -51,12 +51,12 @@ services.AddClientCredentialsTokenManagement()
5151
});
5252
```
5353

54-
## Proof Tokens at the token server's token endpoint
54+
## Proof Tokens At The Token Server's Token Endpoint
5555

5656
Once the key has been configured for the client, then the library will use it to produce a DPoP proof token when calling the token server (including token renewals if relevant).
5757
There is nothing explicit needed on behalf of the developer using this library.
5858

59-
### dpop_jkt at the token server's authorize endpoint
59+
### `dpop_jkt` At The token Server's Authorize Endpoint
6060

6161
When using DPoP and `AddOpenIdConnectAccessTokenManagement`, this library will also automatically include the `dpop_jkt` parameter to the authorize endpoint.
6262

src/content/docs/accesstokenmanagement/advanced/user-tokens.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ builder.Services.AddOpenIdConnectAccessTokenManagement(options =>
3131
});
3232
```
3333

34-
## Per request parameters
34+
## Per Request Parameters
3535

3636
You can also modify token management parameters on a per-request basis.
3737

src/content/docs/accesstokenmanagement/blazor-server.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ public class OidcEvents : OpenIdConnectEvents
6161

6262
Once registered and initialized, Duende.AccessTokenManagement will keep the store up to date automatically as tokens are refreshed.
6363

64-
## Retrieving and using tokens
64+
## Retrieving And Using Tokens
6565

6666
If you've registered your token store with `AddBlazorServerAccessTokenManagement`, Duende.AccessTokenManagement will register the services necessary to attach tokens to outgoing HTTP requests automatically, using the same API as a non-blazor application. You inject an HTTP client factory and resolve named HTTP clients where ever you need to make HTTP requests, and you register the HTTP client's that use access tokens in the DI system with our extension method:
6767

src/content/docs/accesstokenmanagement/web-apps.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ builder.Services.AddOpenIdConnectAccessTokenManagement();
7676

7777
```
7878

79-
### HTTP client factory
79+
### HTTP Client Factory
8080

8181
Similar to the worker service support, you can register HTTP clients that automatically send the access token of the current user when making API calls. The message handler plumbing associated with those HTTP clients will try to make sure, the access token is always valid and not expired.
8282

@@ -152,7 +152,7 @@ public class HomeController : Controller
152152
}
153153
```
154154

155-
### HTTP context extension methods
155+
### HTTP Context Extension Methods
156156

157157
There are three extension methods on the HTTP context that simplify interaction with the token management service:
158158

@@ -173,7 +173,7 @@ public async Task<IActionResult> CallApi()
173173
}
174174
```
175175

176-
### HTTP client factory
176+
### HTTP Client Factory
177177

178178
Last but not least, if you registered clients with the factory, you can simply use them. They will try to make sure that a current access token is always sent along. If that is not possible, ultimately a 401 will be returned to the calling code.
179179

src/content/docs/bff/architecture/third-party-cookies.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ OIDC Silent Login allows a client application to start its session without needi
2525

2626
Similarly to OIDC Session Management, OIDC Silent Login relies on a hidden iframe, though in this case, the hidden iframe makes requests to the OP, passing the *prompt=none* parameter to indicate that user interaction isn't sensible. If that request includes the OP's session cookie, the OP can respond successfully and the application can obtain tokens. But if the request does not include a session - either because no session has been started or because the cookie has been blocked - then the silent login will fail, and the user will have to be redirected to the OP for an interactive login.
2727

28-
### BFF with a Federation Gateway
28+
### BFF With A Federation Gateway
2929

3030
The BFF supports silent login from the SPA with the /bff/silent-login [endpoint](/bff/fundamentals/session/management/silent-login). This endpoint is intended to be invoked in an iframe and issues a challenge to login non-interactively with *prompt=none*. Just as in a traditional SPA, this technique will be disrupted by third party cookie blocking when the BFF and OP are third parties.
3131

src/content/docs/bff/architecture/ui-hosting.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ Microsoft's templates are easy-to-use at dev time from Visual Studio. They allow
5050
template proxies requests to the front end for you. At deploy time, that proxy is removed and the static assets of the
5151
site are served by the static file middleware.
5252

53-
### Host the UI separately
53+
### Host The UI Separately
5454

5555
You may want to host the UI outside the BFF. At development time, UI developers might prefer to run the frontend
5656
outside of Visual Studio (e.g., using the node cli). You might also want to have separate deployments of the frontend
@@ -82,7 +82,7 @@ In order for this architecture to work, the following things are needed:
8282

8383
A sample of this approach is [available](/bff/samples#separate-host-for-ui).
8484

85-
### Serve the index page from the BFF host
85+
### Serve The Index Page From The BFF Host
8686

8787
Lastly, you could serve the index page of the SPA from the BFF, but have all the other static assets hosted on
8888
another host (presumably a CDN). This technique makes the UI and BFF have exactly the same origin, so the authentication

src/content/docs/bff/extensibility/http-forwarder.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ public class MyInvokerFactory : DefaultHttpMessageInvokerFactory
6666
services.AddSingleton<IHttpMessageInvokerFactory, MyInvokerFactory>();
6767
```
6868

69-
### Custom transformations
69+
### Custom Transformations
7070
In the standard configuration, BFF uses the YARP default behavior for forwarding HTTP requests. In addition, we
7171

7272
* remove the sensitive session cookie

src/content/docs/bff/extensibility/tokens.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ builder.Services.AddHttpClient(
3434
You can also supply client assertions to the token management library. See this [sample](/bff/samples) for JWT-based client authentication.
3535
:::
3636

37-
### Custom token storage
37+
### Custom Token Storage
3838
We recommend that you use the default storage mechanism, as this will automatically be compatible with the Duende.BFF server-side sessions.
3939

4040
If you do not use server-side sessions, then the access and refresh token will be stored in the protected session cookie. If you want to change this, you can take over token storage completely.
@@ -83,7 +83,7 @@ public interface IUserTokenStore
8383
}
8484
```
8585

86-
### Per-route customized token retrieval
86+
### Per-route Customized Token Retrieval
8787
The token store defines how tokens are retrieved globally. However, you can add custom logic that changes the way that access tokens are retrieved on a per-route basis. For example, you might need to exchange a token to perform delegation or impersonation for some API calls, depending on the remote API. The interface that describes this extension point is the *IAccessTokenRetriever*.
8888

8989

src/content/docs/bff/fundamentals/apis/local.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ There are two styles of local APIs:
1919
#### Self-Contained Local APIs
2020
These APIs reside within the BFF and don't make HTTP requests to other APIs. They access data controlled by the BFF itself, which can simplify the architecture of the system by reducing the number of APIs that must be deployed and managed. They are suitable for scenarios where the BFF is the sole consumer of the data. If you require data accessibility from other applications or services, this approach is probably not suitable.
2121

22-
#### Local APIs that Make Requests using Managed Access Tokens
22+
#### Local APIs That Make Requests Using Managed Access Tokens
2323
Alternatively, you can make the data available as a service and make HTTP requests to that service from your BFF's local endpoints. The benefits of this style of Local Endpoint include
2424
- Your frontend's network access can be simplified into an aggregated call for the specific data that it needs, which reduces the amount of data that must be sent to the client.
2525
- Your BFF endpoint can expose a subset of your remote APIs so that they are called in a more controlled manner than if the BFF proxied all requests to the endpoint.
@@ -62,14 +62,14 @@ The example above is simplified to demonstrate the way that you might obtain a t
6262
## Securing Local API Endpoints
6363
Regardless of the style of data access used by a local API, it must be protected against threats such as [CSRF (Cross-Site Request Forgery)](https://developer.mozilla.org/en-US/docs/Glossary/CSRF) attacks. To defend against such attacks and ensure that only the frontend can access these endpoints, we recommend implementing two layers of protection.
6464

65-
#### SameSite cookies
65+
#### SameSite Cookies
6666

6767
[The SameSite cookie attribute](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Set-Cookie#samesitesamesite-value) is a feature of modern browsers that restricts cookies so that they are only sent to pages originating from the [site](https://developer.mozilla.org/en-US/docs/Glossary/Site) where the cookie was originally issued.
6868

6969
This is a good first layer of defense, but makes the assumption that you can trust all subdomains of your site. All subdomains within a registrable domain are considered the same site for purposes of SameSite cookies. Thus, if another application hosted on a subdomain within your site is infected with malware, it can make CSRF attacks against your application.
7070

7171

72-
#### Anti-forgery header
72+
#### Anti-forgery Header
7373

7474
For this reason, we recommend requiring an additional custom header on API endpoints, for example:
7575

0 commit comments

Comments
 (0)