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

Updates for v4 #330

Merged
merged 36 commits into from
Nov 22, 2024
Merged

Updates for v4 #330

merged 36 commits into from
Nov 22, 2024

Conversation

bart-vmware
Copy link
Member

@bart-vmware bart-vmware commented Oct 4, 2024

This PR updates (most of) the API documentation for Steeltoe v4.

Global replacements:

  • Update links to learn.microsoft.com, drop /en-us and ?view=
  • Remove references to UseCloudHosting
  • Use markdown style for >NOTE
  • Spelling: replace "CloudFoundry" with "Cloud Foundry"
  • Replace "TAS" with "Tanzu Platform for Cloud Foundry", "TAP" with "Tanzu Platform for Kubernetes"

The API sections that aren't fully updated in this PR (to be addressed separately):

  • Welcome: What's new, breaking changes, etc.
  • Tracing and metrics
    • All files in the /api/v4/tracing directory
    • /api/v4/management/metrics.md
    • /api/v4/management/prometheus.md
  • Security
    • All files in the /api/v4/security directory
  • Cloud Foundry
    • /api/v4/management/cloud-foundry.md

Note

As we don't intend to update the guides, a top banner is added and preliminary changes are reverted from the main branch.

Addresses part of #317.
Fixes #325.

@bart-vmware bart-vmware changed the base branch from main to v4 October 4, 2024 11:34
@bart-vmware bart-vmware force-pushed the updates-for-v4 branch 2 times, most recently from e7e88ac to d27a6b3 Compare October 4, 2024 11:42
Copy link

github-actions bot commented Oct 4, 2024

Preview link: https://docs-steeltoe-pr-330.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 updates-for-v4 branch 6 times, most recently from 43bd0aa to 286c920 Compare November 19, 2024 14:33
guides/messaging/Tutorials/Tutorial1/Readme.md Outdated Show resolved Hide resolved
guides/security/sso-openid-framework.md Outdated Show resolved Hide resolved
api/v4/management/prometheus.md Show resolved Hide resolved
api/v4/management/httpexchanges.md Outdated Show resolved Hide resolved
api/v4/management/env.md Show resolved Hide resolved
api/v4/management/cloud-foundry.md Show resolved Hide resolved
api/v4/management/springbootadmin.md Outdated Show resolved Hide resolved
api/v4/management/springbootadmin.md Outdated Show resolved Hide resolved
api/v4/management/using-endpoints.md Outdated Show resolved Hide resolved
api/v4/management/health.md Show resolved Hide resolved
api/v4/management/cloud-foundry.md Outdated Show resolved Hide resolved
api/v4/management/using-endpoints.md Outdated Show resolved Hide resolved
api/v4/management/using-endpoints.md Outdated Show resolved Hide resolved
example-program.cs Outdated Show resolved Hide resolved
Copy link
Member

@TimHess TimHess left a comment

Choose a reason for hiding this comment

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

LGTM!

@bart-vmware bart-vmware merged commit 69ab51f into v4 Nov 22, 2024
5 checks passed
@bart-vmware bart-vmware deleted the updates-for-v4 branch November 22, 2024 08:17
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