From 11a472188271ab726f511b042241ddb791898a28 Mon Sep 17 00:00:00 2001 From: Bart Koelman <104792814+bart-vmware@users.noreply.github.com> Date: Thu, 23 May 2024 09:24:08 +0200 Subject: [PATCH 1/3] Fixes merge errors from #323 and removes components deleted in Steeltoe v4 --- README.md | 15 ++--- api-v4.json | 57 ------------------- api/browser/v4/all/index.md | 20 +------ build-metadata.sh | 3 +- main-site.localhost.json | 2 +- .../steeltoe/partials/navbar.tmpl.partial | 6 +- template/steeltoe/partials/toc.tmpl.partial | 5 +- 7 files changed, 12 insertions(+), 96 deletions(-) diff --git a/README.md b/README.md index a631dd17..f06365c8 100644 --- a/README.md +++ b/README.md @@ -13,16 +13,7 @@ This is the home of Steeltoe documentation and blog articles. The site uses [Doc | `/guides` | guides for getting started with Steeltoe | `/template` | theming -- /api: holds the project documentation markdown and table of contents - - /v2: version 2 documentation - - /all: this holds generated API docs from doc-comments in source code - - /v3: version 3 documentation - - /all: this holds generated API docs from doc-comments in source code - - /v4: version 4 documentation - - /all: this holds generated API docs from doc-comments in source code -- /articles: holds the markdown for blog posts -- /images: the images -- /template/steeltoe: odd files that overwrite the default DocFX theme +## DocFX Markdown DocFX offers an enhanced flavor of Markdown. To see examples and learn more, view the [DocFX Flavored Markdown](https://dotnet.github.io/docfx/spec/docfx_flavored_markdown.html) documentation. @@ -131,7 +122,7 @@ For working on any non-trivial changes, there are several ways to build and run The easiest way to build and run the site is this command: `docfx build --serve --port 8082`. -### Build API docs for Steeltoe 2 and 3 +### Build API docs for Steeltoe 2, 3 and 4 Building the API docs is not required for the site to run locally. @@ -140,9 +131,11 @@ If needed, these commands will download the Steeltoe source code and generate AP ```bash git clone https://github.com/SteeltoeOSS/Steeltoe sources/v2 -b release/2.5 git clone https://github.com/SteeltoeOSS/Steeltoe sources/v3 -b release/3.2 +git clone https://github.com/SteeltoeOSS/Steeltoe sources/v4 -b release/main git clean -fX api docfx metadata api-v2.json docfx metadata api-v3.json +docfx metadata api-v4.json docfx metadata api-all.json ``` diff --git a/api-v4.json b/api-v4.json index c87c57a0..0843591d 100644 --- a/api-v4.json +++ b/api-v4.json @@ -95,25 +95,6 @@ }, "version": "4.x" }, - { - "src": [ - { - "files": [ - "**/*.csproj" - ], - "exclude": [ "**/bin/**", "**/obj/**" ], - "src": "sources/v4/src/Integration/src" - } - ], - "dest": "api/browser/v4/integration", - "disableGitFeatures": false, - "disableDefaultFilter": false, - "filter": "api-filter.yml", - "properties": { - "TargetFramework": "net6.0" - }, - "version": "4.x" - }, { "src": [ { @@ -152,25 +133,6 @@ }, "version": "4.x" }, - { - "src": [ - { - "files": [ - "**/*.csproj" - ], - "exclude": [ "**/bin/**", "**/obj/**" ], - "src": "sources/v4/src/Messaging/src" - } - ], - "dest": "api/browser/v4/messaging", - "disableGitFeatures": false, - "disableDefaultFilter": false, - "filter": "api-filter.yml", - "properties": { - "TargetFramework": "net6.0" - }, - "version": "4.x" - }, { "src": [ { @@ -189,25 +151,6 @@ "TargetFramework": "net6.0" }, "version": "4.x" - }, - { - "src": [ - { - "files": [ - "**/*.csproj" - ], - "exclude": [ "**/bin/**", "**/obj/**" ], - "src": "sources/v4/src/Stream/src" - } - ], - "dest": "api/browser/v4/stream", - "disableGitFeatures": false, - "disableDefaultFilter": false, - "filter": "api-filter.yml", - "properties": { - "TargetFramework": "net6.0" - }, - "version": "4.x" } ] } diff --git a/api/browser/v4/all/index.md b/api/browser/v4/all/index.md index 7ff75cfc..f74a2253 100644 --- a/api/browser/v4/all/index.md +++ b/api/browser/v4/all/index.md @@ -37,13 +37,7 @@ Contains connectors for simplifying the process of connecting to backing service Contains packages for interacting with service registries. -[view](/api/browser/v4/discovery/Steeltoe.Discovery.html) - -## Steeltoe Integration - -Contains packages for messaging integrations. - -[view](/api/browser/v4/integration/Steeltoe.Integration.html) +[view](/api/browser/v4/discovery/Steeltoe.Discovery.HttpClients.html) ## Steeltoe Logging Extensions @@ -59,20 +53,8 @@ Management tools to help manage and monitor your applications. [view](/api/browser/v4/management/Steeltoe.Management.html) -## Steeltoe Messaging - -Contains messaging support for RabbitMQ. - -[view](/api/browser/v4/messaging/Steeltoe.Messaging.html) - ## Steeltoe Security Authentication and DataProtection libraries using security services on CloudFoundry. [view](/api/browser/v4/security/Steeltoe.Security.Authentication.CloudFoundry.html) - -## Steeltoe Stream - -Contains streaming support for RabbitMQ. - -[view](/api/browser/v4/stream/Steeltoe.Stream.Extensions.html) diff --git a/build-metadata.sh b/build-metadata.sh index 666fe5e3..385456a5 100755 --- a/build-metadata.sh +++ b/build-metadata.sh @@ -27,10 +27,11 @@ get_sources sources/v4 $v4_sources echo "building v2 metadata" docfx metadata api-v2.json -get_sources sources/v3 $v3_sources echo "building v3 metadata" docfx metadata api-v3.json + echo "building v4 metadata" docfx metadata api-v4.json + echo "building all metadata" docfx metadata api-all.json diff --git a/main-site.localhost.json b/main-site.localhost.json index e4f387bd..1c8ad668 100644 --- a/main-site.localhost.json +++ b/main-site.localhost.json @@ -1,3 +1,3 @@ { - "_rootHost": "http://localhost:8080" + "_rootHost": "https://localhost:8080" } diff --git a/template/steeltoe/partials/navbar.tmpl.partial b/template/steeltoe/partials/navbar.tmpl.partial index 2f4105b3..f23b820e 100644 --- a/template/steeltoe/partials/navbar.tmpl.partial +++ b/template/steeltoe/partials/navbar.tmpl.partial @@ -35,12 +35,12 @@
Steeltoe Application Configuration + Steeltoe Dynamic Logging Steeltoe Management - Steeltoe Messaging - Steeltoe Network File Shares + Steeltoe Network File Sharing Steeltoe Security + Steeltoe Service Connectors Steeltoe Service Discovery - Steeltoe Stream
  • diff --git a/template/steeltoe/partials/toc.tmpl.partial b/template/steeltoe/partials/toc.tmpl.partial index 051caf0f..5c82ccaf 100644 --- a/template/steeltoe/partials/toc.tmpl.partial +++ b/template/steeltoe/partials/toc.tmpl.partial @@ -37,13 +37,10 @@ - - + - -