Skip to content

docs: sanitize examples#245

Merged
andybeltz merged 1 commit into
developfrom
docs/sanitize-examples
Apr 29, 2025
Merged

docs: sanitize examples#245
andybeltz merged 1 commit into
developfrom
docs/sanitize-examples

Conversation

@andybeltz
Copy link
Copy Markdown
Contributor

@andybeltz andybeltz commented Apr 29, 2025

Summary

  • Updated Invoke-VcfUpgradePrecheck.md doc to sanitize all the example variables.
  • Updated Publish-BackupStatus.md doc to sanitize all the example variables.
  • Updated Publish-CertificateHealth.md doc to sanitize all the example variables.
  • Updated Publish-ClusterConfiguration.md doc to sanitize all the example variables.
  • Updated Publish-ClusterDrsRule.md doc to sanitize all the example variables.

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 April 29, 2025 05:54
@andybeltz andybeltz self-assigned this Apr 29, 2025
@github-actions github-actions Bot added documentation Documentation needs-review Needs Review labels Apr 29, 2025
@andybeltz andybeltz requested a review from tenthirtyam April 29, 2025 05:55
@tenthirtyam tenthirtyam force-pushed the docs/sanitize-examples branch from 9bfda43 to e797f26 Compare April 29, 2025 11:59
Comment thread docs/documentation/functions/Publish-CertificateHealth.md Outdated
Comment thread docs/documentation/functions/Publish-CertificateHealth.md Outdated
Comment thread docs/documentation/functions/Publish-BackupStatus.md Outdated
Comment thread docs/documentation/functions/Publish-ClusterConfiguration.md Outdated
Comment thread docs/documentation/functions/Publish-ClusterConfiguration.md Outdated
Comment thread docs/documentation/functions/Publish-CertificateHealth.md Outdated
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.

Some minor changes after comparing the examples to the content in the Publish-CertificateHealth function from the module.

@andybeltz andybeltz force-pushed the docs/sanitize-examples branch from f9ae879 to a1696f4 Compare April 29, 2025 19:20
@andybeltz andybeltz requested a review from tenthirtyam April 29, 2025 19:23
Comment thread docs/documentation/functions/Publish-CertificateHealth.md Outdated
-Updated Invoke-VcfUpgradePrecheck.md doc to sanitize all the example variables.
-Updated Publish-BackupStatus.md doc to sanitize all the example variables.
-Updated Publish-CertificateHealth.md doc to sanitize all the example variables.
-Updated Publish-ClusterConfiguration.md doc to sanitize all the example variables.
-Updated Publish-ClusterDrsRule.md doc to sanitize all the example variables.

Signed-off-by: Andy Beltz <andy.beltz@broadcom.com>
@andybeltz andybeltz force-pushed the docs/sanitize-examples branch from a1696f4 to a8cb7aa Compare April 29, 2025 19:27
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.

lgtm!

@andybeltz andybeltz merged commit 6cf2b5d into develop Apr 29, 2025
4 checks passed
@andybeltz andybeltz deleted the docs/sanitize-examples branch April 29, 2025 19:29
@tenthirtyam tenthirtyam removed the needs-review Needs Review label Apr 30, 2025
@tenthirtyam tenthirtyam added this to the .next milestone May 15, 2025
@github-actions
Copy link
Copy Markdown

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 15, 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