-
Notifications
You must be signed in to change notification settings - Fork 15
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore(docs): improve READMEs for individual providers (#369)
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 #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
- Loading branch information
Showing
3 changed files
with
56 additions
and
70 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters