Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation for what's new in Steeltoe v4 #337

Open
wants to merge 8 commits into
base: v4
Choose a base branch
from

Conversation

bart-vmware
Copy link
Member

@bart-vmware bart-vmware commented Jan 12, 2025

Documents what's changed in the Steeltoe codebase, except for Management (will follow later).

Intentionally kept everything on a single page to enable search over all Steeltoe components.

Addresses the "welcome" part of #317.

@bart-vmware bart-vmware changed the base branch from main to v4 January 12, 2025 12:35
Copy link

Preview link: https://docs-steeltoe-pr-337.azurewebsites.net

  • Your changes have been deployed to the preview site. The preview site will update as you add more commits to this branch.
  • The preview link is shareable, but will be deleted when the pull request is merged or closed.

This is an automated message.

@bart-vmware bart-vmware force-pushed the whatsnew-docs-v4 branch 3 times, most recently from 0ab5de4 to 3adf1ce Compare January 13, 2025 09:55
api/v4/welcome/whats-new.md Outdated Show resolved Hide resolved
api/v4/welcome/whats-new.md Outdated Show resolved Hide resolved
api/v4/welcome/whats-new.md Outdated Show resolved Hide resolved
api/v4/welcome/whats-new.md Outdated Show resolved Hide resolved
api/v4/welcome/whats-new.md Outdated Show resolved Hide resolved
api/v4/welcome/whats-new.md Show resolved Hide resolved
api/v4/welcome/whats-new.md Show resolved Hide resolved
api/v4/welcome/whats-new.md Outdated Show resolved Hide resolved
api/v4/welcome/whats-new.md Outdated Show resolved Hide resolved
api/v4/welcome/whats-new.md Outdated Show resolved Hide resolved
@bart-vmware bart-vmware marked this pull request as ready for review January 14, 2025 10:07
@bart-vmware bart-vmware requested a review from TimHess January 14, 2025 10:07
api/v4/welcome/whats-new.md Show resolved Hide resolved
api/v4/welcome/whats-new.md Outdated Show resolved Hide resolved
api/v4/welcome/whats-new.md Show resolved Hide resolved
api/v4/welcome/whats-new.md Show resolved Hide resolved
api/v4/welcome/whats-new.md Show resolved Hide resolved
api/v4/welcome/whats-new.md Show resolved Hide resolved

- Placeholder substitution changed internally (wrapping and taking ownership of sources), should be added as late as possible
- To improve performance, Config Server provider doesn't substitute placeholders by default anymore
- Call `AddPlaceholderResolver()` *before* `AddConfigServer()` to substitute placeholders from local appsettings.json
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- Call `AddPlaceholderResolver()` *before* `AddConfigServer()` to substitute placeholders from local appsettings.json
- Call `AddPlaceholderResolver()` *before* `AddConfigServer()` to substitute placeholders before calling Config Server

Calling it before is really only useful if there's a placeholder used for the Config Server client config, right?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, I suppose it could be something like (not actually existing properties):

{
    "config-server-url": "http://${CONFIG_SERVER_HOSTNAME}:${CONFIG_SERVER_PORT}/path"
}

where CONFIG_SERVER_HOSTNAME and CONFIG_SERVER_PORT are environment variables.

api/v4/welcome/whats-new.md Outdated Show resolved Hide resolved
api/v4/welcome/whats-new.md Outdated Show resolved Hide resolved
api/v4/welcome/whats-new.md Outdated Show resolved Hide resolved
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants