From 5a96f33e8003ec3dbf770761218b14f05f232565 Mon Sep 17 00:00:00 2001 From: Tim Hess Date: Fri, 16 Feb 2024 12:47:03 -0600 Subject: [PATCH] Update bootstrap, jquery, copyright and local-mainsite link (#310) * markdown linting, fix path to SCDF k8s installation guide * disable search, toc tweaks * disentangle from mainsite * set max-width on images #163, #298 Co-authored-by: Bart Koelman <104792814+bart-vmware@users.noreply.github.com> --- .github/workflows/build-and-stage.yml | 5 +- .markdownlint.json | 4 + api-filter.yml | 8 + api-v2.json | 332 ++-- api-v3.json | 417 ++--- api/browser/v2/all/index.md | 10 +- api/browser/v3/all/index.md | 34 +- api/v3/stream/data-flow-stream.md | 20 +- api/v3/stream/stream-reference.md | 31 +- docfx/Dockerfile | 5 +- docfx/docfx_version | 2 +- metadata.json | 4 +- template/steeltoe/partials/affix.tmpl.partial | 1 - .../steeltoe/partials/footer.tmpl.partial | 4 +- template/steeltoe/partials/head.tmpl.partial | 16 +- .../steeltoe/partials/navbar.tmpl.partial | 6 +- .../steeltoe/partials/scripts.tmpl.partial | 25 +- template/steeltoe/partials/toc.tmpl.partial | 27 +- template/steeltoe/styles/docfx.css | 36 +- template/steeltoe/styles/docfx.js | 2 +- template/steeltoe/styles/docfx.vendor.css | 1464 ----------------- template/steeltoe/styles/frommainsite.css | 380 +++++ .../steeltoe/styles/highlightjs-badge.min.js | 1 + template/steeltoe/styles/main.css | 713 ++++---- template/steeltoe/styles/main1.js | 362 ++-- 25 files changed, 1463 insertions(+), 2446 deletions(-) create mode 100644 .markdownlint.json delete mode 100644 template/steeltoe/styles/docfx.vendor.css create mode 100644 template/steeltoe/styles/frommainsite.css create mode 100644 template/steeltoe/styles/highlightjs-badge.min.js diff --git a/.github/workflows/build-and-stage.yml b/.github/workflows/build-and-stage.yml index 08ea56f9..d7489a57 100644 --- a/.github/workflows/build-and-stage.yml +++ b/.github/workflows/build-and-stage.yml @@ -66,7 +66,10 @@ jobs: - name: If PR, create a new staging slot if: ${{ github.event_name == 'pull_request' }} - run: az webapp deployment slot create --resource-group ${{ vars.AZURE_RESOURCE_GROUP }} --name ${{ vars.AZURE_WEBAPP_NAME}} --slot ${{ env.SLOT_NAME }} + run: az webapp deployment slot create --resource-group ${{ vars.AZURE_RESOURCE_GROUP }} --name ${{ vars.AZURE_WEBAPP_NAME}} --slot ${{ env.SLOT_NAME }} --configuration-source ${{ vars.STAGING_SLOT_NAME }} + + # Need to pair a PR slot with a custom MainSite address? + # az webapp config appsettings set -g steeltoe --name docs-steeltoe --slot pr-310 --settings mainsite_host=https://www-steeltoe-pr-141.azurewebsites.net - name: Deploy to staging slot uses: azure/webapps-deploy@v3 diff --git a/.markdownlint.json b/.markdownlint.json new file mode 100644 index 00000000..866ab22e --- /dev/null +++ b/.markdownlint.json @@ -0,0 +1,4 @@ +{ + "MD013": false, + "MD033": { "allowed_elements": ["img"] } +} \ No newline at end of file diff --git a/api-filter.yml b/api-filter.yml index 1c337106..debe72c1 100644 --- a/api-filter.yml +++ b/api-filter.yml @@ -1,4 +1,12 @@ apiRules: +# Excluding types in global namespace, originating from Management/.../DotNetHeapDump +- exclude: + uidRegex: ^$ + type: Namespace +# Excluding types in Graphs namespace, originating from Management/.../DotNetHeapDump +- exclude: + uidRegex: ^Graphs + type: Namespace - exclude: uidRegex: ^OpenCensus\.* type: Namespace diff --git a/api-v2.json b/api-v2.json index 7133d264..cc7a1e0d 100644 --- a/api-v2.json +++ b/api-v2.json @@ -1,194 +1,156 @@ { "metadata": [ - { - "src": [ - { - "files": [ - "**/*.csproj" - ], - "exclude": [ "**/bin/**", "**/obj/**" ], - "src": "sources/v2/src/CircuitBreaker/src" - } - ], - "dest": "api/browser/v2/circuitbreaker", - "disableGitFeatures": false, - "disableDefaultFilter": false, - "filter": "api-filter.yml", - "properties": { - "TargetFramework": "netcoreapp3.1" + { + "src": [ + { + "files": [ + "**/*.csproj" + ], + "exclude": [ "**/bin/**", "**/obj/**" ], + "src": "sources/v2/src/CircuitBreaker/src" + } + ], + "dest": "api/browser/v2/circuitbreaker", + "disableGitFeatures": false, + "disableDefaultFilter": false, + "filter": "api-filter.yml", + "properties": { + "TargetFramework": "netcoreapp3.1" + }, + "version": "2.x" }, - "version": "2.x" - }, - { - "src": [ - { - "files": [ - "**/*.csproj" - ], - "exclude": [ "**/bin/**", "**/obj/**" ], - "src": "sources/v2/src/Common/src" - } - ], - "dest": "api/browser/v2/common", - "disableGitFeatures": false, - "disableDefaultFilter": false, - "filter": "api-filter.yml", - "properties": { - "TargetFramework": "netcoreapp3.1" + { + "src": [ + { + "files": [ + "**/*.csproj" + ], + "exclude": [ "**/bin/**", "**/obj/**" ], + "src": "sources/v2/src/Common/src" + } + ], + "dest": "api/browser/v2/common", + "disableGitFeatures": false, + "disableDefaultFilter": false, + "filter": "api-filter.yml", + "properties": { + "TargetFramework": "netcoreapp3.1" + }, + "version": "2.x" }, - "version": "2.x" - }, - { - "src": [ - { - "files": [ - "**/*.csproj" - ], - "exclude": [ "**/bin/**", "**/obj/**" ], - "src": "sources/v2/src/Configuration/src" - } - ], - "dest": "api/browser/v2/configuration", - "disableGitFeatures": false, - "disableDefaultFilter": false, - "filter": "api-filter.yml", - "properties": { - "TargetFramework": "netcoreapp3.1" + { + "src": [ + { + "files": [ + "**/*.csproj" + ], + "exclude": [ "**/bin/**", "**/obj/**" ], + "src": "sources/v2/src/Configuration/src" + } + ], + "dest": "api/browser/v2/configuration", + "disableGitFeatures": false, + "disableDefaultFilter": false, + "filter": "api-filter.yml", + "properties": { + "TargetFramework": "netcoreapp3.1" + }, + "version": "2.x" }, - "version": "2.x" - }, - { - "src": [ - { - "files": [ - "**/*.csproj" - ], - "exclude": [ "**/bin/**", "**/obj/**" ], - "src": "sources/v2/src/Connectors/src" - } - ], - "dest": "api/browser/v2/connectors", - "disableGitFeatures": false, - "disableDefaultFilter": false, - "filter": "api-filter.yml", - "properties": { - "TargetFramework": "netcoreapp3.1" + { + "src": [ + { + "files": [ + "**/*.csproj" + ], + "exclude": [ "**/bin/**", "**/obj/**" ], + "src": "sources/v2/src/Connectors/src" + } + ], + "dest": "api/browser/v2/connectors", + "disableGitFeatures": false, + "disableDefaultFilter": false, + "filter": "api-filter.yml", + "properties": { + "TargetFramework": "netcoreapp3.1" + }, + "version": "2.x" }, - "version": "2.x" - }, - { - "src": [ - { - "files": [ - "**/*.csproj" - ], - "exclude": [ "**/bin/**", "**/obj/**" ], - "src": "sources/v2/src/Discovery/src" - } - ], - "dest": "api/browser/v2/discovery", - "disableGitFeatures": false, - "disableDefaultFilter": false, - "filter": "api-filter.yml", - "properties": { - "TargetFramework": "netcoreapp3.1" + { + "src": [ + { + "files": [ + "**/*.csproj" + ], + "exclude": [ "**/bin/**", "**/obj/**" ], + "src": "sources/v2/src/Discovery/src" + } + ], + "dest": "api/browser/v2/discovery", + "disableGitFeatures": false, + "disableDefaultFilter": false, + "filter": "api-filter.yml", + "properties": { + "TargetFramework": "netcoreapp3.1" + }, + "version": "2.x" }, - "version": "2.x" - }, - { - "src": [ - { - "files": [ - "**/*.csproj" - ], - "exclude": [ "**/bin/**", "**/obj/**" ], - "src": "sources/v2/src/Integration/src" - } - ], - "dest": "api/browser/v2/integration", - "disableGitFeatures": false, - "disableDefaultFilter": false, - "filter": "api-filter.yml", - "properties": { - "TargetFramework": "netcoreapp3.1" + { + "src": [ + { + "files": [ + "**/*.csproj" + ], + "exclude": [ "**/bin/**", "**/obj/**" ], + "src": "sources/v2/src/Logging/src" + } + ], + "dest": "api/browser/v2/logging", + "disableGitFeatures": false, + "disableDefaultFilter": false, + "filter": "api-filter.yml", + "properties": { + "TargetFramework": "netcoreapp3.1" + }, + "version": "2.x" }, - "version": "2.x" - }, - { - "src": [ - { - "files": [ - "**/*.csproj" - ], - "exclude": [ "**/bin/**", "**/obj/**" ], - "src": "sources/v2/src/Logging/src" - } - ], - "dest": "api/browser/v2/logging", - "disableGitFeatures": false, - "disableDefaultFilter": false, - "filter": "api-filter.yml", - "properties": { - "TargetFramework": "netcoreapp3.1" + { + "src": [ + { + "files": [ + "**/*.csproj" + ], + "exclude": [ "**/bin/**", "**/obj/**" ], + "src": "sources/v2/src/Management/src" + } + ], + "dest": "api/browser/v2/management", + "disableGitFeatures": false, + "disableDefaultFilter": false, + "filter": "api-filter.yml", + "properties": { + "TargetFramework": "netcoreapp3.1" + }, + "version": "2.x" }, - "version": "2.x" - }, - { - "src": [ - { - "files": [ - "**/*.csproj" - ], - "exclude": [ "**/bin/**", "**/obj/**" ], - "src": "sources/v2/src/Management/src" - } - ], - "dest": "api/browser/v2/management", - "disableGitFeatures": false, - "disableDefaultFilter": false, - "filter": "api-filter.yml", - "properties": { - "TargetFramework": "netcoreapp3.1" - }, - "version": "2.x" - }, - { - "src": [ - { - "files": [ - "**/*.csproj" - ], - "exclude": [ "**/bin/**", "**/obj/**" ], - "src": "sources/v2/src/Security/src" - } - ], - "dest": "api/browser/v2/security", - "disableGitFeatures": false, - "disableDefaultFilter": false, - "filter": "api-filter.yml", - "properties": { - "TargetFramework": "netcoreapp3.1" - }, - "version": "2.x" - }, - { - "src": [ - { - "files": [ - "**/*.csproj" - ], - "exclude": [ "**/bin/**", "**/obj/**" ], - "src": "sources/v2/src/Stream/src" - } - ], - "dest": "api/browser/v2/stream", - "disableGitFeatures": false, - "disableDefaultFilter": false, - "filter": "api-filter.yml", - "properties": { - "TargetFramework": "netcoreapp3.1" - }, - "version": "2.x" - } -] -} + { + "src": [ + { + "files": [ + "**/*.csproj" + ], + "exclude": [ "**/bin/**", "**/obj/**" ], + "src": "sources/v2/src/Security/src" + } + ], + "dest": "api/browser/v2/security", + "disableGitFeatures": false, + "disableDefaultFilter": false, + "filter": "api-filter.yml", + "properties": { + "TargetFramework": "netcoreapp3.1" + }, + "version": "2.x" + } + ] +} \ No newline at end of file diff --git a/api-v3.json b/api-v3.json index 789572e4..9620a620 100644 --- a/api-v3.json +++ b/api-v3.json @@ -1,213 +1,232 @@ { "metadata": [ - { - "src": [ - { - "files": [ - "**/*.csproj" - ], - "exclude": [ "**/bin/**", "**/obj/**" ], - "src": "sources/v3/src/CircuitBreaker/src" - } - ], - "dest": "api/browser/v3/circuitbreaker", - "disableGitFeatures": false, - "disableDefaultFilter": false, - "filter": "api-filter.yml", - "properties": { - "TargetFramework": "net5.0" + { + "src": [ + { + "files": [ + "**/*.csproj" + ], + "exclude": [ "**/bin/**", "**/obj/**" ], + "src": "sources/v3/src/Bootstrap/src" + } + ], + "dest": "api/browser/v3/bootstrap", + "disableGitFeatures": false, + "disableDefaultFilter": false, + "filter": "api-filter.yml", + "properties": { + "TargetFramework": "net5.0" + }, + "version": "3.x" }, - "version": "3.x" - }, - { - "src": [ - { - "files": [ - "**/*.csproj" - ], - "exclude": [ "**/bin/**", "**/obj/**" ], - "src": "sources/v3/src/Common/src" - } - ], - "dest": "api/browser/v3/common", - "disableGitFeatures": false, - "disableDefaultFilter": false, - "filter": "api-filter.yml", - "properties": { - "TargetFramework": "net5.0" + { + "src": [ + { + "files": [ + "**/*.csproj" + ], + "exclude": [ "**/bin/**", "**/obj/**" ], + "src": "sources/v3/src/CircuitBreaker/src" + } + ], + "dest": "api/browser/v3/circuitbreaker", + "disableGitFeatures": false, + "disableDefaultFilter": false, + "filter": "api-filter.yml", + "properties": { + "TargetFramework": "net5.0" + }, + "version": "3.x" }, - "version": "3.x" - }, - { - "src": [ - { - "files": [ - "**/*.csproj" - ], - "exclude": [ "**/bin/**", "**/obj/**" ], - "src": "sources/v3/src/Configuration/src" - } - ], - "dest": "api/browser/v3/configuration", - "disableGitFeatures": false, - "disableDefaultFilter": false, - "filter": "api-filter.yml", - "properties": { - "TargetFramework": "net5.0" + { + "src": [ + { + "files": [ + "**/*.csproj" + ], + "exclude": [ "**/bin/**", "**/obj/**" ], + "src": "sources/v3/src/Common/src" + } + ], + "dest": "api/browser/v3/common", + "disableGitFeatures": false, + "disableDefaultFilter": false, + "filter": "api-filter.yml", + "properties": { + "TargetFramework": "net5.0" + }, + "version": "3.x" }, - "version": "3.x" - }, - { - "src": [ - { - "files": [ - "**/*.csproj" - ], - "exclude": [ "**/bin/**", "**/obj/**" ], - "src": "sources/v3/src/Connectors/src" - } - ], - "dest": "api/browser/v3/connectors", - "disableGitFeatures": false, - "disableDefaultFilter": false, - "filter": "api-filter.yml", - "properties": { - "TargetFramework": "net5.0" + { + "src": [ + { + "files": [ + "**/*.csproj" + ], + "exclude": [ "**/bin/**", "**/obj/**" ], + "src": "sources/v3/src/Configuration/src" + } + ], + "dest": "api/browser/v3/configuration", + "disableGitFeatures": false, + "disableDefaultFilter": false, + "filter": "api-filter.yml", + "properties": { + "TargetFramework": "net5.0" + }, + "version": "3.x" }, - "version": "3.x" - }, - { - "src": [ - { - "files": [ - "**/*.csproj" - ], - "exclude": [ "**/bin/**", "**/obj/**" ], - "src": "sources/v3/src/Discovery/src" - } - ], - "dest": "api/browser/v3/discovery", - "disableGitFeatures": false, - "disableDefaultFilter": false, - "filter": "api-filter.yml", - "properties": { - "TargetFramework": "net5.0" + { + "src": [ + { + "files": [ + "**/*.csproj" + ], + "exclude": [ "**/bin/**", "**/obj/**" ], + "src": "sources/v3/src/Connectors/src" + } + ], + "dest": "api/browser/v3/connectors", + "disableGitFeatures": false, + "disableDefaultFilter": false, + "filter": "api-filter.yml", + "properties": { + "TargetFramework": "net5.0" + }, + "version": "3.x" }, - "version": "3.x" - }, - { - "src": [ - { - "files": [ - "**/*.csproj" - ], - "exclude": [ "**/bin/**", "**/obj/**" ], - "src": "sources/v3/src/Integration/src" - } - ], - "dest": "api/browser/v3/integration", - "disableGitFeatures": false, - "disableDefaultFilter": false, - "filter": "api-filter.yml", - "properties": { - "TargetFramework": "net5.0" + { + "src": [ + { + "files": [ + "**/*.csproj" + ], + "exclude": [ "**/bin/**", "**/obj/**" ], + "src": "sources/v3/src/Discovery/src" + } + ], + "dest": "api/browser/v3/discovery", + "disableGitFeatures": false, + "disableDefaultFilter": false, + "filter": "api-filter.yml", + "properties": { + "TargetFramework": "net5.0" + }, + "version": "3.x" }, - "version": "3.x" - }, - { - "src": [ - { - "files": [ - "**/*.csproj" - ], - "exclude": [ "**/bin/**", "**/obj/**" ], - "src": "sources/v3/src/Logging/src" - } - ], - "dest": "api/browser/v3/logging", - "disableGitFeatures": false, - "disableDefaultFilter": false, - "filter": "api-filter.yml", - "properties": { - "TargetFramework": "net5.0" + { + "src": [ + { + "files": [ + "**/*.csproj" + ], + "exclude": [ "**/bin/**", "**/obj/**" ], + "src": "sources/v3/src/Integration/src" + } + ], + "dest": "api/browser/v3/integration", + "disableGitFeatures": false, + "disableDefaultFilter": false, + "filter": "api-filter.yml", + "properties": { + "TargetFramework": "net5.0" + }, + "version": "3.x" }, - "version": "3.x" - }, - { - "src": [ - { - "files": [ - "**/*.csproj" - ], - "exclude": [ "**/bin/**", "**/obj/**" ], - "src": "sources/v3/src/Management/src" - } - ], - "dest": "api/browser/v3/management", - "disableGitFeatures": false, - "disableDefaultFilter": false, - "filter": "api-filter.yml", - "properties": { - "TargetFramework": "net5.0" + { + "src": [ + { + "files": [ + "**/*.csproj" + ], + "exclude": [ "**/bin/**", "**/obj/**" ], + "src": "sources/v3/src/Logging/src" + } + ], + "dest": "api/browser/v3/logging", + "disableGitFeatures": false, + "disableDefaultFilter": false, + "filter": "api-filter.yml", + "properties": { + "TargetFramework": "net5.0" + }, + "version": "3.x" }, - "version": "3.x" - }, - { - "src": [ - { - "files": [ - "**/*.csproj" - ], - "exclude": [ "**/bin/**", "**/obj/**" ], - "src": "sources/v3/src/Messaging/src" - } - ], - "dest": "api/browser/v3/messaging", - "disableGitFeatures": false, - "disableDefaultFilter": false, - "filter": "api-filter.yml", - "properties": { - "TargetFramework": "net5.0" + { + "src": [ + { + "files": [ + "**/*.csproj" + ], + "exclude": [ "**/bin/**", "**/obj/**" ], + "src": "sources/v3/src/Management/src" + } + ], + "dest": "api/browser/v3/management", + "disableGitFeatures": false, + "disableDefaultFilter": false, + "filter": "api-filter.yml", + "properties": { + "TargetFramework": "net5.0" + }, + "version": "3.x" }, - "version": "3.x" - }, - { - "src": [ - { - "files": [ - "**/*.csproj" - ], - "exclude": [ "**/bin/**", "**/obj/**" ], - "src": "sources/v3/src/Security/src" - } - ], - "dest": "api/browser/v3/security", - "disableGitFeatures": false, - "disableDefaultFilter": false, - "filter": "api-filter.yml", - "properties": { - "TargetFramework": "net5.0" + { + "src": [ + { + "files": [ + "**/*.csproj" + ], + "exclude": [ "**/bin/**", "**/obj/**" ], + "src": "sources/v3/src/Messaging/src" + } + ], + "dest": "api/browser/v3/messaging", + "disableGitFeatures": false, + "disableDefaultFilter": false, + "filter": "api-filter.yml", + "properties": { + "TargetFramework": "net5.0" + }, + "version": "3.x" }, - "version": "3.x" - }, - { - "src": [ - { - "files": [ - "**/*.csproj" - ], - "exclude": [ "**/bin/**", "**/obj/**" ], - "src": "sources/v3/src/Stream/src" - } - ], - "dest": "api/browser/v3/stream", - "disableGitFeatures": false, - "disableDefaultFilter": false, - "filter": "api-filter.yml", - "properties": { - "TargetFramework": "net5.0" + { + "src": [ + { + "files": [ + "**/*.csproj" + ], + "exclude": [ "**/bin/**", "**/obj/**" ], + "src": "sources/v3/src/Security/src" + } + ], + "dest": "api/browser/v3/security", + "disableGitFeatures": false, + "disableDefaultFilter": false, + "filter": "api-filter.yml", + "properties": { + "TargetFramework": "net5.0" + }, + "version": "3.x" }, - "version": "3.x" - } + { + "src": [ + { + "files": [ + "**/*.csproj" + ], + "exclude": [ "**/bin/**", "**/obj/**" ], + "src": "sources/v3/src/Stream/src" + } + ], + "dest": "api/browser/v3/stream", + "disableGitFeatures": false, + "disableDefaultFilter": false, + "filter": "api-filter.yml", + "properties": { + "TargetFramework": "net5.0" + }, + "version": "3.x" + } ] -} +} \ No newline at end of file diff --git a/api/browser/v2/all/index.md b/api/browser/v2/all/index.md index 68079799..1a47205c 100644 --- a/api/browser/v2/all/index.md +++ b/api/browser/v2/all/index.md @@ -13,7 +13,13 @@ uid: api/browser/v2/all/index Steeltoe's port of [Netflix Hystrix](https://github.com/Netflix/Hystrix) to .NET. -[view](/api/browser/v2/all/Steeltoe.CircuitBreaker.Hystrix.html) +[view](/api/browser/v2/circuitbreaker/Steeltoe.CircuitBreaker.Hystrix.html) + +## Steeltoe Common + +Contains several packages that are common to other Steeltoe components. + +[view](/api/browser/v2/common/Steeltoe.Common.html) ## Steeltoe Configuration Providers @@ -37,7 +43,7 @@ Contains packages for interacting with service registries. Logging extensions that, when used with Steeltoe Management, enable changing the Logging levels for a running application at run-time, without restarting the app. -Currently supporting the Microsoft Console Logger and Serilog. +Currently supports the Microsoft Console Logger and Serilog. [view](/api/browser/v2/logging/Steeltoe.Extensions.Logging.html) diff --git a/api/browser/v3/all/index.md b/api/browser/v3/all/index.md index c6f55815..4964a8f3 100644 --- a/api/browser/v3/all/index.md +++ b/api/browser/v3/all/index.md @@ -9,11 +9,23 @@ uid: api/browser/v3/all/index # Steeltoe Namespaces +## Steeltoe Bootstrap + +Extension methods on host-builders that automatically activate Steeltoe features, based on the assemblies used by your app. + +[view](/api/browser/v3/bootstrap/Steeltoe.Bootstrap.AutoConfig.html) + ## Steeltoe Circuit Breaker Steeltoe's port of [Netflix Hystrix](https://github.com/Netflix/Hystrix) to .NET. -[view](/api/browser/v3/all/Steeltoe.CircuitBreaker.html) +[view](/api/browser/v3/circuitbreaker/Steeltoe.CircuitBreaker.html) + +## Steeltoe Common + +Contains several packages that are common to other Steeltoe components. + +[view](/api/browser/v3/common/Steeltoe.Common.html) ## Steeltoe Configuration Providers @@ -33,11 +45,17 @@ Contains packages for interacting with service registries. [view](/api/browser/v3/discovery/Steeltoe.Discovery.html) +## Steeltoe Integration + +Contains packages for messaging integrations. + +[view](/api/browser/v3/integration/Steeltoe.Integration.html) + ## Steeltoe Logging Extensions Logging extensions that, when used with Steeltoe Management, enable changing the Logging levels for a running application at run-time, without restarting the app. -Currently supporting the Microsoft Console Logger and Serilog. +Currently supports the Microsoft Console Logger and Serilog. [view](/api/browser/v3/logging/Steeltoe.Extensions.Logging.html) @@ -47,8 +65,20 @@ Management tools to help manage and monitor your applications. [view](/api/browser/v3/management/Steeltoe.Management.html) +## Steeltoe Messaging + +Contains messaging support for RabbitMQ. + +[view](/api/browser/v3/messaging/Steeltoe.Messaging.html) + ## Steeltoe Security Authentication and DataProtection libraries which simplify interacting with CredHub and using security services on CloudFoundry. [view](/api/browser/v3/security/Steeltoe.Security.Authentication.CloudFoundry.html) + +## Steeltoe Stream + +Contains streaming support for RabbitMQ. + +[view](/api/browser/v3/stream/Steeltoe.Stream.Extensions.html) \ No newline at end of file diff --git a/api/v3/stream/data-flow-stream.md b/api/v3/stream/data-flow-stream.md index 092096fc..effe7e3c 100644 --- a/api/v3/stream/data-flow-stream.md +++ b/api/v3/stream/data-flow-stream.md @@ -79,7 +79,7 @@ Applications in Spring Cloud Data Flow are registered as named resources so that The URI conforms to a [schema](https://docs.spring.io/spring-cloud-dataflow/docs/current/reference/htmlsingle/#spring-cloud-dataflow-register-stream-apps). ->As of Steeltoe 3.1.0-rc1 only Docker images are supported. +> Spring Cloud Data Flow only supports running .NET applications in Docker images Data Flow defines some logical application types to indicate its role as a streaming component, a task, or a standalone application. For streaming applications, as you might expect, we use `Source`,`Processor`, and `Sink` types. @@ -240,29 +240,29 @@ To run data through the stream, POST data to the HttpSource application using a ### Kubernetes -Once you have the Spring Cloud Data Flow server running in Kubernetes (by following the instructions from the [installation guide](%currentPath%/installation/kubernetes/)), you can: +Once you have the Spring Cloud Data Flow server running in Kubernetes (by following the instructions from the [installation guide](https://dataflow.spring.io/docs/installation/kubernetes/)), you can: -- Register the stream applications -- Create, deploy, and manage streams +* Register the stream applications +* Create, deploy, and manage streams #### Registering Applications with Spring Cloud Data Flow server For the `Http` source, use the following: -``` +```text docker:springcloudstream/http-source-rabbit:3.0.1 ``` For the `BasicStreamProcessor` processor, use the following: -``` +```text docker://projects.registry.vmware.com/steeltoe/basicstreamprocessor:latest ``` For the `BasicStreamSink` sink, use the following: -``` +```text docker://projects.registry.vmware.com/steeltoe/basicstreamprocessor:latest ``` @@ -280,7 +280,7 @@ To lists the pods (including the server components and the streaming application kubectl get pods ``` -``` +```text NAME READY STATUS RESTARTS AGE scdf-release-mariadb-0 1/1 Running 0 4d scdf-release-rabbitmq-0 1/1 Running 0 4d @@ -307,7 +307,7 @@ http --json POST http://localhost:8081 "test=data" kubectl logs steeltoestream-steeltoebasicsink-v2-5fd5c84448-f2w5b ``` -``` +```text info: Steeltoe.Stream.Binder.Rabbit.RabbitMessageChannelBinder[0] Channel 'steeltoestream.steeltoebasicprocessor.steeltoestream.errors' has 1 subscriber(s). info: Steeltoe.Stream.Binder.Rabbit.RabbitMessageChannelBinder[0] @@ -326,7 +326,7 @@ info: CloudDataflowSink.Program[0] In this section, we deployed the stream by using Spring Cloud Data Flow with the stream DSL: -``` +```text http | steeltoebasicprocessor | steeltoebasicsink ``` diff --git a/api/v3/stream/stream-reference.md b/api/v3/stream/stream-reference.md index cf467d84..93f54b69 100644 --- a/api/v3/stream/stream-reference.md +++ b/api/v3/stream/stream-reference.md @@ -93,7 +93,7 @@ Doing so prevents the service instances from receiving duplicate messages unless >Anonymous subscriptions are non-durable by nature. For some Binder implementations (such as RabbitMQ), it is possible to have non-durable group subscriptions as well. -### Partitioning +### Partitioning Data Stream provides support for partitioning data between multiple instances of a given service. In a partitioned scenario, the physical communication medium (such as the broker topic) is viewed as being structured into multiple partitions. @@ -425,7 +425,6 @@ wire format, typically a `byte[]`, to the desired type exposed in the methods si +``` +--> ### Binder Configuration @@ -1347,8 +1347,8 @@ If this property is not set, any destination can be bound dynamically. The `BinderAwareChannelResolver` can be used directly, as shown in the following example of a console application receiving messages from an input source and deciding the target channel based on the body of the message (see [Dynamic Destination Sample](https://github.com/SteeltoeOSS/Samples/tree/main/Stream/DynamicDestinationMessaging) for full solution): - Program.cs + ```csharp [EnableBinding(typeof(ISink))] class Program @@ -1377,6 +1377,7 @@ class Program ``` appsettings.json + ```json { "spring": { @@ -1588,6 +1589,7 @@ Consequently, custom `IMessageConverter` implementations take precedence over th The following example shows how to create a message converter bean to support a new content type called `application/bar`: Startup.cs + ```csharp public void ConfigureServices(IServiceCollection services) { @@ -1598,6 +1600,7 @@ public void ConfigureServices(IServiceCollection services) ``` MyCustomMessageConverter.cs + ```csharp public class MyCustomMessageConverter : AbstractMessageConverter { @@ -1625,7 +1628,7 @@ public class MyCustomMessageConverter : AbstractMessageConverter return $"{bar.Name} has been processed"; } } -``` +``` ## Inter-Application Communication @@ -1757,7 +1760,7 @@ public class CustomPartitionKeyExtractorClass : IPartitionSelectorStrategy An input binding (with the channel name `input`) is configured to receive partitioned data by configuring its `partitioned` setting, as well as the `instanceIndex` and `instanceCount` settings on the application itself, as shown in the following example: -``` +```text spring:cloud:stream:bindings:input:consumer:partitioned=True spring:cloud:stream:instanceIndex=3 spring:cloud:stream:instanceCount=5 diff --git a/docfx/Dockerfile b/docfx/Dockerfile index bdd051a8..aa44785b 100644 --- a/docfx/Dockerfile +++ b/docfx/Dockerfile @@ -6,7 +6,8 @@ RUN \ git \ unzip \ vim \ - wget + wget \ + dos2unix RUN \ wget https://packages.microsoft.com/config/debian/$(cat /etc/issue | awk '{print $3}')/packages-microsoft-prod.deb -O packages-microsoft-prod.deb && \ dpkg -i packages-microsoft-prod.deb && \ @@ -15,7 +16,7 @@ RUN \ apt install -y dotnet-sdk-8.0 COPY . . RUN \ - wget https://github.com/dotnet/docfx/releases/download/$(cat docfx_version)/docfx.zip && \ + wget https://github.com/dotnet/docfx/releases/download/$(cat docfx_version | dos2unix)/docfx.zip && \ mkdir -p /usr/local/libexec && \ unzip docfx.zip -d /usr/local/libexec/docfx && \ install docfx /usr/local/bin && \ diff --git a/docfx/docfx_version b/docfx/docfx_version index 90d58ce4..54f15969 100644 --- a/docfx/docfx_version +++ b/docfx/docfx_version @@ -1 +1 @@ -v2.59.2 +v2.59.2 diff --git a/metadata.json b/metadata.json index 2cc2483d..73fae8ff 100644 --- a/metadata.json +++ b/metadata.json @@ -9,11 +9,11 @@ "__global.improveThisDoc": "Edit this page", "_gitContribute": { - "repo": "https://github.com/steeltoeoss/Documentation", + "repo": "https://github.com/SteeltoeOSS/Documentation", "branch": "main", "apiSpecFolder": "docs-ref-overwrite" }, - "_enableSearch": true, + "_enableSearch": false, "_noindex": false, "_disableContribution": false, diff --git a/template/steeltoe/partials/affix.tmpl.partial b/template/steeltoe/partials/affix.tmpl.partial index 6d7a18b6..ea165b50 100644 --- a/template/steeltoe/partials/affix.tmpl.partial +++ b/template/steeltoe/partials/affix.tmpl.partial @@ -20,6 +20,5 @@ {{/_disableContribution}} diff --git a/template/steeltoe/partials/footer.tmpl.partial b/template/steeltoe/partials/footer.tmpl.partial index 1a813f1b..5eafb670 100644 --- a/template/steeltoe/partials/footer.tmpl.partial +++ b/template/steeltoe/partials/footer.tmpl.partial @@ -10,7 +10,7 @@
- Copyright © 2005-2023 Broadcom. All Rights Reserved. The term "Broadcom" refers to Broadcom Inc. and/or its subsidiaries.
+ Copyright © 2005-2024 Broadcom. All Rights Reserved. The term "Broadcom" refers to Broadcom Inc. and/or its subsidiaries.
• Privacy Policy • Your California Privacy Rights • Terms of Use @@ -21,7 +21,7 @@
- +
diff --git a/template/steeltoe/partials/head.tmpl.partial b/template/steeltoe/partials/head.tmpl.partial index ab9e4da6..a8b4466a 100644 --- a/template/steeltoe/partials/head.tmpl.partial +++ b/template/steeltoe/partials/head.tmpl.partial @@ -1,8 +1,8 @@ + - @@ -32,18 +32,18 @@ {{#_description}}{{/_description}} - - - - - - + + + + + + {{#_noindex}}{{/_noindex}} - {{#_enableSearch}}{{/_enableSearch}} + {{#_enableSearch}}{{/_enableSearch}} {{#_enableNewTab}}{{/_enableNewTab}} {{#_disableNav}}{{/_disableNav}} diff --git a/template/steeltoe/partials/navbar.tmpl.partial b/template/steeltoe/partials/navbar.tmpl.partial index 919e421f..acdb6b02 100644 --- a/template/steeltoe/partials/navbar.tmpl.partial +++ b/template/steeltoe/partials/navbar.tmpl.partial @@ -4,7 +4,7 @@