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

chore(docs): improve READMEs for individual providers #369

Merged
merged 2 commits into from
Dec 12, 2023

Conversation

xiehan
Copy link
Contributor

@xiehan xiehan commented Dec 12, 2023

Couple of minor but IMO powerful improvements to the provider READMEs:

  • Puts the true underlying version number in the title instead of the tracked version (I have never ever found the tracked version to be helpful in practice)
  • Includes a link to the Registry page earlier on in the document (I look for this often and hate having to scroll so far down to find it)
  • Removes text about "This links to the minimum version being tracked" which is no longer relevant as a result of Mark's changes merged in feat: added underlying terraform provider version to readme #342

It's worth noting that in the snapshot tests, underlyingTerraformVersion is always unset, but in the actual provider repos in practice, it is always set. See here for an example: https://github.com/cdktf/cdktf-provider-aws/blob/main/README.md

@xiehan xiehan requested a review from a team as a code owner December 12, 2023 11:06
@xiehan xiehan requested review from ansgarm and DanielMSchmidt and removed request for a team December 12, 2023 11:06
@DanielMSchmidt DanielMSchmidt merged commit 5f67384 into main Dec 12, 2023
7 checks passed
@DanielMSchmidt DanielMSchmidt deleted the readme-improvements branch December 12, 2023 13:53
Copy link

I'm going to lock this pull request because it has been closed for at least 7 days. This helps our maintainers find and focus on the active issues. If you've found a problem that seems related to this change, please open a new issue so we can investigate further.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Dec 20, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants