Skip to content

Conversation

@sun-mir
Copy link

@sun-mir sun-mir commented Nov 2, 2025

Description

⚠️ Only *.mdx related documentation changes

Background

The existing plugin documentation page is badly formatted and hard to use. My MR attempts to fix some of the problems and use the observed best practices from other pages

Existing ToC image

Changes

  • standardized H2 vs H3 (vs H4) headers
  • changed H3 titles for repeatable Optional (fields) sections to bold styling
  • wrapped HCL2/JSON code snippets into switchable table divs
  • deleted duplicated paragraph for Communicator Configuration
  • moved section about SSH key pair automation under the original Communicator Configuration paragraph

Resolved Issues

No tracked issues exist

Rollback Plan

Unlikely applicable since PR brings no functional source code changes...

Changes to Security Controls

N/a

@sun-mir sun-mir requested a review from a team as a code owner November 2, 2025 20:12
@hashicorp-cla-app
Copy link

hashicorp-cla-app bot commented Nov 2, 2025

CLA assistant check
All committers have signed the CLA.

@hashicorp-cla-app
Copy link

CLA assistant check

Thank you for your submission! We require that all contributors sign our Contributor License Agreement ("CLA") before we can accept the contribution. Read and sign the agreement

Learn more about why HashiCorp requires a CLA and what the CLA includes

Have you signed the CLA already but the status is still pending? Recheck it.

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.

1 participant