Skip to content

docs: sanitize examples#250

Merged
tenthirtyam merged 1 commit into
developfrom
docs/sanitize-examples
May 7, 2025
Merged

docs: sanitize examples#250
tenthirtyam merged 1 commit into
developfrom
docs/sanitize-examples

Conversation

@andybeltz
Copy link
Copy Markdown
Contributor

Summary

  • Updated Invoke-VcfAlertReport.md doc to sanitize all the example variables, add brackets and punctuation.
  • Updated Invoke-VcfHealthReport.md doc to sanitize all the example variables, add brackets and punctuation.
  • Updated Publish-ClusterConfiguration.md doc to sanitize all the example variables, add brackets and punctuation.
  • Updated Publish-ComponentConnectivityHealth.md doc to sanitize all the example variables, add brackets and punctuation.
  • Updated Publish-ConnectivityHealth.md doc to sanitize all the example variables, add brackets and punctuation.
  • Updated Publish-EsxiAlert.md doc to sanitize all the example variables, add brackets and punctuation.
  • Updated Publish-EsxiConnectionHealth.md doc to sanitize all the example variables, add brackets and punctuation.
  • Updated Publish-EsxiSecurityConfiguration.md doc to sanitize all the example variables, add brackets and punctuation.
  • Updated Publish-NsxtCombinedHealth.md doc to sanitize all the example variables, add brackets and punctuation.
  • Updated Publish-NsxtHealthNonSOS.md doc to sanitize all the example variables, add brackets and punctuation.
  • Updated Publish-NsxtTier0BgpStatus.md doc to sanitize all the example variables, add brackets and punctuation.
  • Updated Publish-NsxtTransportNodeStatus.md doc to sanitize all the example variables, add brackets and punctuation.
  • Updated Publish-NsxtTransportNodeTunnelStatus.md doc to sanitize all the example variables, add brackets and punctuation.
  • Updated Publish-NtpHealth.md doc to sanitize all the example variables, add brackets and punctuation.
  • Updated Publish-PasswordHealth.md doc to sanitize all the example variables, add brackets and punctuation.

Type

  • Bugfix
  • Enhancement or Feature
  • Code Style or Formatting
  • Documentation
  • Refactoring
  • Chore
  • Other
    Please describe:

Breaking Changes?

  • Yes, there are breaking changes.
  • No, there are no breaking changes.

Test and Documentation

  • Tests have been completed.
  • Documentation has been added or updated.

Issue References

Additional Information

@andybeltz andybeltz requested a review from a team as a code owner May 7, 2025 17:27
@github-actions github-actions Bot added documentation Documentation needs-review Needs Review labels May 7, 2025
@andybeltz andybeltz requested a review from tenthirtyam May 7, 2025 17:28
Comment thread docs/documentation/functions/Invoke-VcfHealthReport.md Outdated
- Updated `Invoke-VcfAlertReport.md` doc to sanitize all the example variables, add brackets and punctuation.
- Updated `Invoke-VcfHealthReport.md` doc to sanitize all the example variables, add brackets and punctuation.
- Updated `Publish-ClusterConfiguration.md` doc to sanitize all the example variables, add brackets and punctuation.
- Updated `Publish-ComponentConnectivityHealth.md` doc to sanitize all the example variables, add brackets and punctuation.
- Updated `Publish-ConnectivityHealth.md` doc to sanitize all the example variables, add brackets and punctuation.
- Updated `Publish-EsxiAlert.md` doc to sanitize all the example variables, add brackets and punctuation.
- Updated `Publish-EsxiConnectionHealth.md` doc to sanitize all the example variables, add brackets and punctuation.
- Updated `Publish-EsxiSecurityConfiguration.md` doc to sanitize all the example variables, add brackets and punctuation.
- Updated `Publish-NsxtCombinedHealth.md` doc to sanitize all the example variables, add brackets and punctuation.
- Updated `Publish-NsxtHealthNonSOS.md` doc to sanitize all the example variables, add brackets and punctuation.
- Updated `Publish-NsxtTier0BgpStatus.md` doc to sanitize all the example variables, add brackets and punctuation.
- Updated `Publish-NsxtTransportNodeStatus.md` doc to sanitize all the example variables, add brackets and punctuation.
- Updated `Publish-NsxtTransportNodeTunnelStatus.md` doc to sanitize all the example variables, add brackets and punctuation.
- Updated `Publish-NtpHealth.md` doc to sanitize all the example variables, add brackets and punctuation.
- Updated `Publish-PasswordHealth.md` doc to sanitize all the example variables, add brackets and punctuation.

Signed-off-by: Andy Beltz <andy.beltz@broadcom.com>
@tenthirtyam tenthirtyam force-pushed the docs/sanitize-examples branch from 0e4baef to 0bf523d Compare May 7, 2025 17:59
Copy link
Copy Markdown
Contributor

@tenthirtyam tenthirtyam left a comment

Choose a reason for hiding this comment

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

Looks good!

@tenthirtyam tenthirtyam merged commit 67fb54f into develop May 7, 2025
4 checks passed
@tenthirtyam tenthirtyam deleted the docs/sanitize-examples branch May 7, 2025 18:00
@tenthirtyam tenthirtyam removed the needs-review Needs Review label May 7, 2025
@tenthirtyam tenthirtyam added this to the .next milestone May 7, 2025
@github-actions
Copy link
Copy Markdown

github-actions Bot commented Jun 7, 2025

I'm going to lock this pull request because it has been closed for 30 days. This helps our maintainers find and focus on the active issues.

If you have found a problem that seems related to this change, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further.

@github-actions github-actions Bot locked as resolved and limited conversation to collaborators Jun 7, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

documentation Documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants