-
Notifications
You must be signed in to change notification settings - Fork 3
docs(README): intended terraform links #190
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
Conversation
WalkthroughThe pull request involves a minor update to the README.md file for the Ably Terraform Provider. The change specifically updates the URL referencing the Terraform Plugin Protocol documentation, ensuring that users are directed to the most current and accurate link for version 6 of the protocol documentation. Changes
Poem
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 0
🧹 Nitpick comments (1)
README.md (1)
18-18
: Format the URL as a proper markdown link.The URL update to the Terraform Plugin Protocol documentation is appropriate and provides more accurate reference material. However, let's improve the markdown formatting to follow best practices.
Apply this change to format the URL as a proper markdown link:
-This provider is built on top of Terraform Protocol 6.0, which is compatible with Terraform CLI version 1.0 and later (see more: https://www.terraform.io/plugin/terraform-plugin-protocol#protocol-version-6). +This provider is built on top of Terraform Protocol 6.0, which is compatible with Terraform CLI version 1.0 and later (see more: [Terraform Plugin Protocol v6](https://www.terraform.io/plugin/terraform-plugin-protocol#protocol-version-6)).🧰 Tools
🪛 Markdownlint (0.37.0)
18-18: null
Bare URL used(MD034, no-bare-urls)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
README.md
(1 hunks)
🧰 Additional context used
🪛 Markdownlint (0.37.0)
README.md
18-18: null
Bare URL used
(MD034, no-bare-urls)
docs(README): links caption
Thank you for the contribution guspan-tanadi. |
Summary by CodeRabbit