Skip to content

Conversation

@adambarreiro
Copy link
Contributor

@adambarreiro adambarreiro commented Apr 7, 2025

This PR transforms the old-style documentation for Terraform providers to the new one.

Tests and GH Actions are also updated accordingly.

abarreiro added 4 commits April 7, 2025 10:28
Signed-off-by: abarreiro <[email protected]>
#
Signed-off-by: abarreiro <[email protected]>
#
Signed-off-by: abarreiro <[email protected]>
@adambarreiro adambarreiro self-assigned this Apr 7, 2025
abarreiro added 3 commits April 7, 2025 10:48
Signed-off-by: abarreiro <[email protected]>
Signed-off-by: abarreiro <[email protected]>
Signed-off-by: abarreiro <[email protected]>
@adambarreiro adambarreiro marked this pull request as ready for review April 7, 2025 09:06
Copy link
Contributor

@Didainius Didainius left a comment

Choose a reason for hiding this comment

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

Thanks, 🤞🏻

@adambarreiro adambarreiro requested a review from tenthirtyam April 7, 2025 09:49
Copy link
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.

Consider adding "Resource: " or "Datasource: " before each H1 header to ensure that the reader understands the context if landing on the page without using the navigation.

For example:

# Data Source: vcfa_content_library_item
# Resource: vcfa_content_library_item

Copy link
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.

11 instances of vcfa\_ still exist in the ./docs/resources path within the markdown H1s.

abarreiro added 5 commits April 8, 2025 09:19
@adambarreiro adambarreiro changed the title Modernize docs Modernize docs and update GitHub Actions Apr 8, 2025
Signed-off-by: abarreiro <[email protected]>
Copy link

@lvirbalas lvirbalas left a comment

Choose a reason for hiding this comment

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

Thank you!

@adambarreiro adambarreiro merged commit 134116b into vmware:main Apr 9, 2025
3 checks passed
@adambarreiro adambarreiro deleted the modernize-docs branch April 9, 2025 12:23
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.

4 participants