Merge branch 'main' into wca/introspection-foss-docs

Author: wcabus

.dockerignore

@@ -0,0 +1,33 @@
+**/.dockerignore
+**/.env
+**/.git
+**/.gitignore
+**/.project
+**/.settings
+**/.toolstarget
+**/.vs
+**/.vscode
+**/.idea
+**/*.*proj.user
+**/*.dbmdl
+**/*.jfm
+**/azds.yaml
+**/bin
+**/node_modules
+**/npm-debug.log
+**/obj
+**/secrets.dev.yaml
+**/values.dev.yaml
+
+**/.devcontainer
+**/.fleet
+**/.husky
+**/.run
+**/.space
+**/dist
+docker-compose*.yml
+Dockerfile*
+LICENSE
+LICENSE-CODE
+README.md
+redirect.conf

.github/workflows/link-checker.yml

@@ -37,5 +37,5 @@ jobs:
         env:
           GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
         with:
-          args: "--no-progress --max-concurrency 8 --skip-missing --accept 200,429 --exclude-path root/llms.txt --exclude-path root/llms-full.txt --exclude-path root/llms-small.txt --exclude-loopback --require-https --exclude sample.duendesoftware.com --exclude docs.duendesoftware.com --exclude sitemap --exclude \"https://github.com/DuendeArchive/IdentityModel.AspNetCore/\" --root-dir \"$PWD/root\" root/**"
+          args: "--no-progress --max-concurrency 8 --skip-missing --accept 200,429 --exclude-path root/_llms-txt --exclude-path root/llms.txt --exclude-path root/llms-full.txt --exclude-path root/llms-small.txt --exclude-loopback --require-https --exclude sample.duendesoftware.com --exclude sitemap --exclude \"https://github.com/DuendeArchive/IdentityModel.AspNetCore/\" --root-dir \"$PWD/root\" root/**"
           fail: true

Dockerfile

@@ -0,0 +1,33 @@
+FROM node:22-alpine AS builder
+
+EXPOSE 8080
+
+WORKDIR /app
+COPY package.json package-lock.json ./
+RUN npm install --no-cache
+COPY . .
+RUN chmod +x build.sh
+
+RUN ./build.sh
+
+FROM nginx:stable-alpine AS final
+
+ARG APPLICATION_VERSION
+COPY deployment/nginx.conf /etc/nginx/nginx.conf
+COPY deployment/default.conf /etc/nginx/conf.d/default.conf
+RUN sed -i "s|\$APPLICATION_VERSION|${APPLICATION_VERSION}|g" /etc/nginx/conf.d/default.conf
+COPY --from=builder --chown=nginx:nginx /app/root/redirect.conf /etc/nginx/extra/redirect.conf
+
+RUN rm -rf /usr/share/nginx/html/*
+COPY --from=builder --chown=nginx:nginx /app/root/ /usr/share/nginx/html/
+RUN rm -rf /usr/share/nginx/html/redirect.conf
+
+RUN mkdir -p /var/cache/nginx
+
+RUN chown -R nginx:nginx /var/cache/nginx
+RUN touch /var/run/nginx.pid && \
+        chown -R nginx:nginx /var/run/nginx.pid
+
+USER nginx
+
+WORKDIR /usr/share/nginx/html

README.md

@@ -4,7 +4,7 @@ Welcome to the documentation of all [Duende Software](https://duendesoftware.com
 
 ## Getting Started
 
-You will need Node 22+ installed on your operating system and in the PATH.
+You will need Node 22+ installed on your operating system and available in the PATH.
 
 * Run `npm install` to restore all dependencies.
 * Use `npm run dev` to run the documentation site locally.
@@ -153,4 +153,4 @@ For all licensing information, refer to the relevant license files:
 * [LICENSE](LICENSE) - License for the documentation site content.
 * [LICENSE-CODE](LICENSE-CODE) - License for the code samples.
 
-The Astro documentation engine is licensed under the [MIT license](https://github.com/withastro/astro/blob/main/LICENSE).
+The Astro documentation engine is licensed under the [MIT license](https://github.com/withastro/astro/blob/main/LICENSE).

astro.config.mjs

@@ -16,6 +16,7 @@ import * as fs from "node:fs";
 // https://github.com/withastro/astro/issues/9782
 import { duendeOpenGraphImage } from "./src/plugins/duende-og-image.js";
 import removeMarkdownExtensions from "./src/plugins/remove-markdown-extensions.js";
+import staticRedirects from "./src/plugins/static-redirects.js";
 
 // https://astro.build/config
 export default defineConfig({
@@ -39,7 +40,57 @@ export default defineConfig({
       customCss: ["./src/styles/custom.css"],
       routeMiddleware: ["./src/plugins/search-topic-middleware.ts"],
       plugins: [
-        starlightLlmsTxt(),
+        starlightLlmsTxt({
+          pageSeparator: "\n-----\n",
+          customSets: [
+            {
+              label: "General Information",
+              description:
+                "General Information about Duende products, including license information, support options, security best practices and a glossary.",
+              paths: ["general/**"],
+            },
+            {
+              label: "IdentityServer",
+              description: "Documentation for Duende IdentityServer",
+              paths: ["identityserver/**"],
+            },
+            {
+              label: "IdentityServer Quickstarts",
+              description:
+                "Step-by-step tutorials to get started with Duende IdentityServer",
+              paths: ["identityserver/quickstarts/**"],
+            },
+            {
+              label: "IdentityServer Sample Code",
+              description: "Sample projects for Duende IdentityServer",
+              paths: ["identityserver/samples/**"],
+            },
+            {
+              label: "BFF Security Framework",
+              description:
+                "Documentation for Duende's Backend for Frontend (BFF) framework, used to secure browser-based frontends (e.g. SPAs with React, Vue, Angular, or Blazor applications) with ASP.NET Core backends",
+              paths: ["bff/**"],
+            },
+            {
+              label: "Access Token Management",
+              description:
+                "Documentation for Duende's open-source Access Token Management library which provides automatic access token management features for .NET worker and ASP.NET Core web applications",
+              paths: ["accesstokenmanagement/**"],
+            },
+            {
+              label: "IdentityModel",
+              description:
+                "Documentation for Duende's open-source IdentityModel library which provides an object model to interact with the endpoints defined in the various OAuth and OpenId Connect specifications",
+              paths: ["accesstokenmanagement/**"],
+            },
+            {
+              label: "IdentityModel.OidcClient",
+              description:
+                "Documentation for Duende's open-source IdentityModel.OidcClient library which can be used to build OIDC native clients with a variety of .NET UI tools",
+              paths: ["identitymodel-oidcclient/**"],
+            },
+          ],
+        }),
         starlightHeadingBadges(),
         starlightAutoSidebar(),
         starlightGiscus({
@@ -174,6 +225,7 @@ export default defineConfig({
     redirectFrom({
       contentDir: "./src/content/docs",
     }),
+    staticRedirects(),
     opengraphImages({
       options: {
         fonts: [

build.sh

@@ -1,3 +1,4 @@
+#!/bin/sh
 set -e
 
 npm install

deployment/default.conf

@@ -0,0 +1,21 @@
+server {
+    listen       8080;
+    listen  [::]:8080;
+    server_name  localhost;
+    location / {
+        root   /usr/share/nginx/html;
+        index  index.html index.htm;
+        add_header X-REVISION $APPLICATION_VERSION;
+    }
+    include /etc/nginx/extra/*.conf;
+
+    error_page 404 /404.html;
+    location = /404.html {
+        root   /usr/share/nginx/html;
+    }
+
+    error_page   500 502 503 504  /50x.html;
+    location = /50x.html {
+        root   /usr/share/nginx/html;
+    }
+}

deployment/nginx.conf

@@ -0,0 +1,31 @@
+user  nginx;
+worker_processes  auto;
+
+error_log  /var/log/nginx/error.log notice;
+pid        /var/run/nginx.pid;
+
+
+events {
+    worker_connections  1024;
+}
+
+
+http {
+    include       /etc/nginx/mime.types;
+    default_type  application/octet-stream;
+
+    log_format  main  '$remote_addr - $remote_user [$time_local] "$request" '
+                      '$status $body_bytes_sent "$http_referer" '
+                      '"$http_user_agent" "$http_x_forwarded_for"';
+
+    access_log  /var/log/nginx/access.log  main;
+
+    sendfile        on;
+    #tcp_nopush     on;
+
+    keepalive_timeout  65;
+
+    gzip  on;
+
+    include /etc/nginx/conf.d/*.conf;
+}