-
Notifications
You must be signed in to change notification settings - Fork 1
feat(oss-iac): adds first cut at OSS IaC article #59
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
base: master
Are you sure you want to change the base?
Conversation
✅ Deploy Preview for masterpoint ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
""" WalkthroughA new blog post, "Your Infra Isn’t Special: Why Open Source Infrastructure as Code (IaC) Wins," has been added. The article discusses the advantages of open source IaC modules, addresses common objections, provides evaluation criteria, and offers resources and guidance for adopting OSS IaC. Additionally, the repository’s default code owners have been changed from the open-source team to the internal team. Changes
Sequence Diagram(s)sequenceDiagram
participant Reader
participant Blog
participant ExternalResources
Reader->>Blog: Accesses new blog post "Your Infra Isn’t Special"
Blog->>Reader: Presents arguments for OSS IaC adoption
Blog->>Reader: Addresses common objections and provides evaluation guide
Reader->>ExternalResources: Follows links to module libraries and references
Suggested reviewers
Note ⚡️ AI Code Reviews for VS Code, Cursor, WindsurfCodeRabbit now has a plugin for VS Code, Cursor and Windsurf. This brings AI code reviews directly in the code editor. Each commit is reviewed immediately, finding bugs before the PR is raised. Seamless context handoff to your AI code agent ensures that you can easily incorporate review feedback. Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. 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: 3
🧹 Nitpick comments (5)
content/blog/oss-iac.md (5)
1-11
: Validate frontmatter metadata and slug consistency
The frontmatter fields look correct, but please verify that:
- The unicode apostrophe in the title is supported by your site generator (or consider a straight apostrophe).
- The
slug
(why-open-source-iac-wins
) aligns with your URL scheme.- The image at
/img/updates/oss-iac/oss-iac.png
is actually added to the repo.Would you like me to generate a quick shell script to confirm the image’s presence and list your generated permalinks?
13-13
: Convert HTML heading to Markdown for consistency
Using raw HTML for the Table of Contents bypasses Markdown linting and styling. Consider:-<h2>Table of Contents</h2> +## Table of Contents
39-39
: Insert missing comma and remove unnecessary comma
Improve readability by adding a comma after the introductory phrase and dropping the extra comma:-For us that means using reusable, OSS modules for Terraform, OpenTofu, or Pulumi. +For us, that means using reusable OSS modules for Terraform, OpenTofu, or Pulumi.🧰 Tools
🪛 LanguageTool
[formatting] ~39-~39: Insert a comma after “For us,”.
Context: ...ortant is Infrastructure as Code (IaC). For us that means using reusable, OSS modules ...(INTRODUCTORY_PHRASE_MISSING_COMMA)
74-75
: Standardize unordered list style
Switch from asterisk bullets to dashes to match the document’s convention:-* Your code that uses the modules gets the best practices they implement “out of the box”. -* You can look to these modules for inspiration around tasks like naming and tagging, improving your own IaC code. +- Your code that uses the modules gets the best practices they implement “out of the box”. +- You can look to these modules for inspiration around tasks like naming and tagging, improving your own IaC code.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
74-74: Unordered list style
Expected: dash; Actual: asterisk(MD004, ul-style)
75-75: Unordered list style
Expected: dash; Actual: asterisk(MD004, ul-style)
97-99
: Standardize unordered list style in maintenance section
Convert the asterisk bullets to dashes for consistency:-* run into a particular issue -* thought through it -* and provided a fix or turnkey way to implement it +- run into a particular issue +- thought through it +- and provided a fix or turnkey way to implement it🧰 Tools
🪛 LanguageTool
[uncategorized] ~97-~97: This verb may not be in the correct tense. Consider changing the tense to fit the context better.
Context: ...r because the community has already: * run into a particular issue * thought throu...(AI_EN_LECTOR_REPLACEMENT_VERB_TENSE)
🪛 markdownlint-cli2 (0.17.2)
97-97: Unordered list style
Expected: dash; Actual: asterisk(MD004, ul-style)
98-98: Unordered list style
Expected: dash; Actual: asterisk(MD004, ul-style)
99-99: Unordered list style
Expected: dash; Actual: asterisk(MD004, ul-style)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (2)
static/img/updates/oss-iac/naming-hard.png
is excluded by!**/*.png
static/img/updates/oss-iac/oss-iac.png
is excluded by!**/*.png
📒 Files selected for processing (1)
content/blog/oss-iac.md
(1 hunks)
🧰 Additional context used
🪛 LanguageTool
content/blog/oss-iac.md
[uncategorized] ~37-~37: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...Intro At Masterpoint, we’re big on open source software (OSS). Outside of the few vend...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[style] ~37-~37: This phrase is redundant. Consider using “Outside”.
Context: ... big on open source software (OSS). Outside of the few vendors that make our lives and...
(OUTSIDE_OF)
[formatting] ~39-~39: Insert a comma after “For us,”.
Context: ...ortant is Infrastructure as Code (IaC). For us that means using reusable, OSS modules ...
(INTRODUCTORY_PHRASE_MISSING_COMMA)
[uncategorized] ~58-~58: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...e topics, we’ll share examples of solid open source modules. We’re biased towards [the amaz...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[style] ~58-~58: Consider using a more formal and expressive alternative to ‘amazing’.
Context: ...urce modules. We’re biased towards [the amazing module library](https://docs.cloudposse...
(AWESOME)
[style] ~62-~62: The verb “get” can be informal. Consider replacing it with a form of “to be”.
Context: ...ces There are many best practices that get built into OSS IaC modules, but I’ll focus on...
(GET_USED_ARE_USED)
[style] ~62-~62: As an alternative to the over-used intensifier ‘extremely’, consider replacing this phrase.
Context: ...modules, but I’ll focus on two that are extremely important: Naming + Tagging. {{< lightboximg "/i...
(EN_WEAK_ADJECTIVE)
[uncategorized] ~70-~70: These words/punctuation marks might seem a little out of order. For clarity and coherence, try switching them around.
Context: ...vironment. These components of the name also are built into the tags. By leveraging OSS...
(AI_EN_LECTOR_REPLACEMENT_WORD_ORDER)
[uncategorized] ~79-~79: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...C code. ### Security Hardened Because open source modules are being used by hundreds or t...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[uncategorized] ~81-~81: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ... bare minimum, those engineers need the open source module that they’re using to have setti...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[style] ~81-~81: The phrase ‘have the ability to’ might be wordy. Consider using “can”.
Context: ... requirements. This means that you also have the ability to configure these modules in a secure fas...
(HAS_THE_ABILITY_TO)
[style] ~81-~81: Consider replacing this phrase with the adverb “securely” to avoid wordiness.
Context: ... the ability to configure these modules in a secure fashion. At best, these developers upstream cod...
(IN_A_X_MANNER)
[uncategorized] ~85-~85: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...#L207-L233)). There are also plenty of open source modules that are scanned by security en...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[uncategorized] ~85-~85: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...v`. [We do this at Masterpoint with our open source modules](https://github.com/masterpoint...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[uncategorized] ~87-~87: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...u would upgrade your usage of the module and you’d then be more secure. Less work, m...
(COMMA_COMPOUND_SENTENCE)
[style] ~93-~93: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ... fix any bug that crops up. You’ll also need to add features; you might be the platform...
(REP_NEED_TO_VB)
[uncategorized] ~95-~95: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...ound the corner 😁). When you’re using open source modules, you often find exactly what yo...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[uncategorized] ~97-~97: This verb may not be in the correct tense. Consider changing the tense to fit the context better.
Context: ...r because the community has already: * run into a particular issue * thought throu...
(AI_EN_LECTOR_REPLACEMENT_VERB_TENSE)
[uncategorized] ~103-~103: A comma is probably missing here.
Context: ... of our projects and client work is. Of course we’re not the only ones! But when IPv6...
(MISSING_COMMA_AFTER_INTRODUCTORY_PHRASE)
[uncategorized] ~115-~115: The preposition “of” seems more likely in this position.
Context: ...ting codebase complexity. As an example for this reason to use OSS, let’s look at t...
(AI_EN_LECTOR_REPLACEMENT_PREPOSITION)
[uncategorized] ~121-~121: Possible missing comma found.
Context: ...ntain!) those 2K lines of code for your organization or for you to consume those 3 modules a...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~129-~129: Possible missing comma found.
Context: ....org/wiki/Leaky_abstraction)” This can happen and there are good examples of OSS modu...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~133-~133: Possible missing comma found.
Context: ...cific version, and update when you need to then you won’t run into the dependency ...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~137-~137: Possible missing comma found.
Context: ...reason” This is a sad reality for some folks and to those folks I suggest: Copy / pa...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~144-~144: Possible missing comma found.
Context: ...rden! ## How to evaluate good OSS IaC Above I suggest that you need to do your own ...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~149-~149: Use a comma before “or” if it connects two independent clauses (unless they are closely connected and short).
Context: ...t Does it default to support your needs or can you configure it to support your ne...
(COMMA_COMPOUND_SENTENCE_4)
[uncategorized] ~153-~153: Use a comma before “and” if it connects two independent clauses (unless they are closely connected and short).
Context: ...support Is your version of TF supported and can you use the module without upgradin...
(COMMA_COMPOUND_SENTENCE_4)
[style] ~153-~153: The expression “make sense” can be too colloquial for certain contexts. For a more formal tone, try using an alternative.
Context: ...n you use the module without upgrading? Does it make sense to upgrade if you need to for this use-...
(WOULD_IT_MAKE_SENSE)
[uncategorized] ~161-~161: Possible missing comma found.
Context: ...you to supply a ton of values for it to work or does it have reasonable defaults? #...
(AI_HYDRA_LEO_MISSING_COMMA)
🪛 markdownlint-cli2 (0.17.2)
content/blog/oss-iac.md
74-74: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
75-75: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
97-97: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
98-98: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
99-99: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
127-127: Heading levels should only increment by one level at a time
Expected: h3; Actual: h4
(MD001, heading-increment)
147-147: Heading levels should only increment by one level at a time
Expected: h3; Actual: h4
(MD001, heading-increment)
⏰ Context from checks skipped due to timeout of 90000ms (3)
- GitHub Check: Redirect rules - masterpoint
- GitHub Check: Header rules - masterpoint
- GitHub Check: Pages changed - masterpoint
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.
Looks awesome! 👏
Just several suggestions.
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
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
♻️ Duplicate comments (2)
content/blog/oss-iac.md (2)
123-141
: Normalize heading levels for objections.
Each objection is currently an H4 (####
) under an H2 section; these should be H3 to maintain proper document hierarchy.Example diff:
- #### “There are too many inputs to so-and-so module – [it feels like a leaky abstraction](...) + ### “There are too many inputs to so-and-so module – [it feels like a leaky abstraction](...) - #### “Using external modules sounds like dependency hell" + ### “Using external modules sounds like dependency hell” - #### “We can’t use open-source in my organization because of XYZ reason” + ### “We can’t use open-source in my organization because of XYZ reason” - #### “But I can generate all this IaC with AI… why wouldn’t I do that?” + ### “But I can generate all this IaC with AI… why wouldn’t I do that?”🧰 Tools
🪛 LanguageTool
[uncategorized] ~129-~129: Possible missing comma found.
Context: ....org/wiki/Leaky_abstraction)” This can happen and there are good examples of OSS modu...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~133-~133: Possible missing comma found.
Context: ...cific version, and update when you need to then you won’t run into the dependency ...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~137-~137: Possible missing comma found.
Context: ...reason” This is a sad reality for some folks and to those folks I suggest: Copy / pa...(AI_HYDRA_LEO_MISSING_COMMA)
🪛 markdownlint-cli2 (0.17.2)
127-127: Heading levels should only increment by one level at a time
Expected: h3; Actual: h4(MD001, heading-increment)
143-172
: Normalize heading levels for evaluation criteria.
The criteria under “How to evaluate good OSS IaC” are H4 but should be H3 to follow a single-level increment rule.Example diff:
- #### Check the feature support + ### Check the feature support - #### What version of TF does it support + ### What version of TF does it support - #### Evaluate the scope of the module + ### Evaluate the scope of the module - #### Check the number of required `variable` inputs + ### Check the number of required `variable` inputs - #### Ensure the module has tests and follows good practices + ### Ensure the module has tests and follows good practices - #### Investigate if there is a community behind the module + ### Investigate if there is a community behind the module🧰 Tools
🪛 LanguageTool
[uncategorized] ~144-~144: Possible missing comma found.
Context: ...rden! ## How to evaluate good OSS IaC Above I suggest that you need to do your own ...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~149-~149: Use a comma before “or” if it connects two independent clauses (unless they are closely connected and short).
Context: ...t Does it default to support your needs or can you configure it to support your ne...(COMMA_COMPOUND_SENTENCE_4)
[uncategorized] ~153-~153: Use a comma before “and” if it connects two independent clauses (unless they are closely connected and short).
Context: ...support Is your version of TF supported and can you use the module without upgradin...(COMMA_COMPOUND_SENTENCE_4)
[style] ~153-~153: The expression “make sense” can be too colloquial for certain contexts. For a more formal tone, try using an alternative.
Context: ...n you use the module without upgrading? Does it make sense to upgrade if you need to for this use-...(WOULD_IT_MAKE_SENSE)
🪛 markdownlint-cli2 (0.17.2)
147-147: Heading levels should only increment by one level at a time
Expected: h3; Actual: h4(MD001, heading-increment)
🧹 Nitpick comments (4)
content/blog/oss-iac.md (4)
13-34
: Unify quotation marks in the Table of Contents entry.
The TOC entry for “Using external modules sounds like dependency hell” mixes curly and straight quotes, which can break link matching and anchors. Consider using consistent ASCII quotes or matching curly quotes on both ends.Example diff:
- - [“Using external modules sounds like dependency hell"](#using-external-modules-sounds-like-dependency-hell) + - ["Using external modules sounds like dependency hell"](#using-external-modules-sounds-like-dependency-hell)
35-42
: Add missing comma after introductory phrase.
The sentence at line 39 should read "For us, that means ..." to adhere to standard comma usage after introductory phrases.- For us that means using reusable, OSS modules for Terraform, OpenTofu, or Pulumi. + For us, that means using reusable, OSS modules for Terraform, OpenTofu, or Pulumi.🧰 Tools
🪛 LanguageTool
[uncategorized] ~37-~37: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...Intro At Masterpoint, we’re big on open source software (OSS). Outside of the few vend...(EN_COMPOUND_ADJECTIVE_INTERNAL)
[style] ~37-~37: This phrase is redundant. Consider using “Outside”.
Context: ... big on open source software (OSS). Outside of the few vendors that make our lives and...(OUTSIDE_OF)
[formatting] ~39-~39: Insert a comma after “For us,”.
Context: ...ortant is Infrastructure as Code (IaC). For us that means using reusable, OSS modules ...(INTRODUCTORY_PHRASE_MISSING_COMMA)
60-76
: Use consistent list bullet style.
The unordered lists under Best Practices use*
, but the repository style prefers-
. Consider replacing these bullets for consistency.Example diff:
- * Your code that uses the modules gets the best practices they implement “out of the box”. - * You can look to these modules for inspiration around tasks like naming and tagging, improving your own IaC code. + - Your code that uses the modules gets the best practices they implement “out of the box”. + - You can look to these modules for inspiration around tasks like naming and tagging, improving your own IaC code.🧰 Tools
🪛 LanguageTool
[style] ~62-~62: The verb “get” can be informal. Consider replacing it with a form of “to be”.
Context: ...ces There are many best practices that get built into OSS IaC modules, but I’ll focus on...(GET_USED_ARE_USED)
[style] ~62-~62: As an alternative to the over-used intensifier ‘extremely’, consider replacing this phrase.
Context: ...modules, but I’ll focus on two that are extremely important: Naming + Tagging. {{< lightboximg "/i...(EN_WEAK_ADJECTIVE)
🪛 markdownlint-cli2 (0.17.2)
74-74: Unordered list style
Expected: dash; Actual: asterisk(MD004, ul-style)
75-75: Unordered list style
Expected: dash; Actual: asterisk(MD004, ul-style)
89-106
: Consistent list bullet style in Less Maintenance.
Similar to Best Practices, switch the*
bullets to-
for uniform styling across lists.Example diff:
- * run into a particular issue - * thought through it - * and provided a fix or turnkey way to implement it + - run into a particular issue + - thought through it + - and provided a fix or turnkey way to implement it🧰 Tools
🪛 LanguageTool
[style] ~93-~93: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ... fix any bug that crops up. You’ll also need to add features; you might be the platform...(REP_NEED_TO_VB)
[uncategorized] ~95-~95: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...ound the corner 😁). When you’re using open source modules, you often find exactly what yo...(EN_COMPOUND_ADJECTIVE_INTERNAL)
[uncategorized] ~103-~103: A comma is probably missing here.
Context: ... of our projects and client work is. Of course we’re not the only ones! But when IPv6...(MISSING_COMMA_AFTER_INTRODUCTORY_PHRASE)
🪛 markdownlint-cli2 (0.17.2)
97-97: Unordered list style
Expected: dash; Actual: asterisk(MD004, ul-style)
98-98: Unordered list style
Expected: dash; Actual: asterisk(MD004, ul-style)
99-99: Unordered list style
Expected: dash; Actual: asterisk(MD004, ul-style)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting
📒 Files selected for processing (1)
content/blog/oss-iac.md
(1 hunks)
🧰 Additional context used
🪛 LanguageTool
content/blog/oss-iac.md
[uncategorized] ~37-~37: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...Intro At Masterpoint, we’re big on open source software (OSS). Outside of the few vend...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[style] ~37-~37: This phrase is redundant. Consider using “Outside”.
Context: ... big on open source software (OSS). Outside of the few vendors that make our lives and...
(OUTSIDE_OF)
[formatting] ~39-~39: Insert a comma after “For us,”.
Context: ...ortant is Infrastructure as Code (IaC). For us that means using reusable, OSS modules ...
(INTRODUCTORY_PHRASE_MISSING_COMMA)
[uncategorized] ~58-~58: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...e topics, we’ll share examples of solid open source modules. We’re biased towards [the amaz...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[style] ~58-~58: Consider using a more formal and expressive alternative to ‘amazing’.
Context: ...urce modules. We’re biased towards [the amazing module library](https://docs.cloudposse...
(AWESOME)
[style] ~62-~62: The verb “get” can be informal. Consider replacing it with a form of “to be”.
Context: ...ces There are many best practices that get built into OSS IaC modules, but I’ll focus on...
(GET_USED_ARE_USED)
[style] ~62-~62: As an alternative to the over-used intensifier ‘extremely’, consider replacing this phrase.
Context: ...modules, but I’ll focus on two that are extremely important: Naming + Tagging. {{< lightboximg "/i...
(EN_WEAK_ADJECTIVE)
[uncategorized] ~79-~79: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...C code. ### Security Hardened Because open source modules are being used by hundreds or t...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[uncategorized] ~81-~81: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ... bare minimum, those engineers need the open source module that they’re using to have setti...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[style] ~81-~81: The phrase ‘have the ability to’ might be wordy. Consider using “can”.
Context: ... requirements. This means that you also have the ability to configure these modules in a secure fas...
(HAS_THE_ABILITY_TO)
[style] ~81-~81: Consider replacing this phrase with the adverb “securely” to avoid wordiness.
Context: ... the ability to configure these modules in a secure fashion. At best, these developers upstream cod...
(IN_A_X_MANNER)
[uncategorized] ~85-~85: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...#L207-L233)). There are also plenty of open source modules that are scanned by security en...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[uncategorized] ~85-~85: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...v`. [We do this at Masterpoint with our open source modules](https://github.com/masterpoint...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[uncategorized] ~87-~87: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...u would upgrade your usage of the module and you’d then be more secure. Less work, m...
(COMMA_COMPOUND_SENTENCE)
[style] ~93-~93: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ... fix any bug that crops up. You’ll also need to add features; you might be the platform...
(REP_NEED_TO_VB)
[uncategorized] ~95-~95: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...ound the corner 😁). When you’re using open source modules, you often find exactly what yo...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[uncategorized] ~103-~103: A comma is probably missing here.
Context: ... of our projects and client work is. Of course we’re not the only ones! But when IPv6...
(MISSING_COMMA_AFTER_INTRODUCTORY_PHRASE)
[uncategorized] ~121-~121: Possible missing comma found.
Context: ...ntain!) those 2K lines of code for your organization or for you to consume those 3 modules a...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~129-~129: Possible missing comma found.
Context: ....org/wiki/Leaky_abstraction)” This can happen and there are good examples of OSS modu...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~133-~133: Possible missing comma found.
Context: ...cific version, and update when you need to then you won’t run into the dependency ...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~137-~137: Possible missing comma found.
Context: ...reason” This is a sad reality for some folks and to those folks I suggest: Copy / pa...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~144-~144: Possible missing comma found.
Context: ...rden! ## How to evaluate good OSS IaC Above I suggest that you need to do your own ...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~149-~149: Use a comma before “or” if it connects two independent clauses (unless they are closely connected and short).
Context: ...t Does it default to support your needs or can you configure it to support your ne...
(COMMA_COMPOUND_SENTENCE_4)
[uncategorized] ~153-~153: Use a comma before “and” if it connects two independent clauses (unless they are closely connected and short).
Context: ...support Is your version of TF supported and can you use the module without upgradin...
(COMMA_COMPOUND_SENTENCE_4)
[style] ~153-~153: The expression “make sense” can be too colloquial for certain contexts. For a more formal tone, try using an alternative.
Context: ...n you use the module without upgrading? Does it make sense to upgrade if you need to for this use-...
(WOULD_IT_MAKE_SENSE)
🪛 markdownlint-cli2 (0.17.2)
content/blog/oss-iac.md
74-74: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
75-75: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
97-97: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
98-98: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
99-99: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
127-127: Heading levels should only increment by one level at a time
Expected: h3; Actual: h4
(MD001, heading-increment)
147-147: Heading levels should only increment by one level at a time
Expected: h3; Actual: h4
(MD001, heading-increment)
🔇 Additional comments (5)
content/blog/oss-iac.md (5)
1-11
: Front matter looks solid. The YAML metadata and callout are correctly structured, and all required fields (visible, draft, title, author, slug, date, description, image) are present.
47-58
: The Why section is clear.
The numbered list outlining the four key reasons is well formatted and follows markdown conventions.🧰 Tools
🪛 LanguageTool
[uncategorized] ~58-~58: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...e topics, we’ll share examples of solid open source modules. We’re biased towards [the amaz...(EN_COMPOUND_ADJECTIVE_INTERNAL)
[style] ~58-~58: Consider using a more formal and expressive alternative to ‘amazing’.
Context: ...urce modules. We’re biased towards [the amazing module library](https://docs.cloudposse...(AWESOME)
77-88
: Security Hardened section is well articulated.
The examples and links effectively illustrate the benefits of community-vetted security.🧰 Tools
🪛 LanguageTool
[uncategorized] ~79-~79: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...C code. ### Security Hardened Because open source modules are being used by hundreds or t...(EN_COMPOUND_ADJECTIVE_INTERNAL)
[uncategorized] ~81-~81: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ... bare minimum, those engineers need the open source module that they’re using to have setti...(EN_COMPOUND_ADJECTIVE_INTERNAL)
[style] ~81-~81: The phrase ‘have the ability to’ might be wordy. Consider using “can”.
Context: ... requirements. This means that you also have the ability to configure these modules in a secure fas...(HAS_THE_ABILITY_TO)
[style] ~81-~81: Consider replacing this phrase with the adverb “securely” to avoid wordiness.
Context: ... the ability to configure these modules in a secure fashion. At best, these developers upstream cod...(IN_A_X_MANNER)
[uncategorized] ~85-~85: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...#L207-L233)). There are also plenty of open source modules that are scanned by security en...(EN_COMPOUND_ADJECTIVE_INTERNAL)
[uncategorized] ~85-~85: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...v`. [We do this at Masterpoint with our open source modules](https://github.com/masterpoint...(EN_COMPOUND_ADJECTIVE_INTERNAL)
[uncategorized] ~87-~87: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...u would upgrade your usage of the module and you’d then be more secure. Less work, m...(COMMA_COMPOUND_SENTENCE)
107-120
: Day-0 and Day-2 Complexity section is clear.
The analogy and LOC comparison reinforce the point effectively without issues.
173-185
: Conclusion and resources section is well written.
Links and call-to-action are clear and correctly formatted.
Co-authored-by: Veronika Gnilitska <30597968+gberenice@users.noreply.github.com>
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
♻️ Duplicate comments (2)
content/blog/oss-iac.md (2)
127-139
: Normalize heading levels for “Objections” sub-sections
These H4 headings under an H2 should be H3 to maintain a proper hierarchy.- #### “There are too many inputs to so-and-so module – [it feels like a leaky abstraction](…)" - #### “Using external modules sounds like dependency hell” - #### “We can’t use open source in my organization because of XYZ reason” - #### “But I can generate all this IaC with AI… why wouldn’t I do that?” + ### “There are too many inputs to so-and-so module – [it feels like a leaky abstraction](…)" + ### “Using external modules sounds like dependency hell” + ### “We can’t use open source in my organization because of XYZ reason” + ### “But I can generate all this IaC with AI… why wouldn’t I do that?”🧰 Tools
🪛 LanguageTool
[uncategorized] ~129-~129: Possible missing comma found.
Context: ....org/wiki/Leaky_abstraction)” This can happen and there are good examples of OSS modu...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~133-~133: Possible missing comma found.
Context: ...cific version, and update when you need to then you won’t run into the dependency ...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~137-~137: Possible missing comma found.
Context: ...reason” This is a sad reality for some folks and to those folks I suggest: Copy / pa...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~137-~137: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...those folks I suggest: Copy / pasta the open source module into your codebase, abiding by t...(EN_COMPOUND_ADJECTIVE_INTERNAL)
🪛 markdownlint-cli2 (0.17.2)
127-127: Heading levels should only increment by one level at a time
Expected: h3; Actual: h4(MD001, heading-increment)
147-167
: Normalize heading levels for “How to evaluate good OSS IaC”
Convert these H4 subheadings to H3 to follow the MD001 rule.- #### Check the feature support - #### What version of TF does it support - #### Evaluate the scope of the module - #### Check the number of required `variable` inputs - #### Ensure the module has tests and follows good practices - #### Investigate if there is a community behind the module + ### Check the feature support + ### What version of TF does it support + ### Evaluate the scope of the module + ### Check the number of required `variable` inputs + ### Ensure the module has tests and follows good practices + ### Investigate if there is a community behind the module🧰 Tools
🪛 LanguageTool
[uncategorized] ~149-~149: Use a comma before “or” if it connects two independent clauses (unless they are closely connected and short).
Context: ...t Does it default to support your needs or can you configure it to support your ne...(COMMA_COMPOUND_SENTENCE_4)
[uncategorized] ~153-~153: Use a comma before “and” if it connects two independent clauses (unless they are closely connected and short).
Context: ...support Is your version of TF supported and can you use the module without upgradin...(COMMA_COMPOUND_SENTENCE_4)
[style] ~153-~153: The expression “make sense” can be too colloquial for certain contexts. For a more formal tone, try using an alternative.
Context: ...n you use the module without upgrading? Does it make sense to upgrade if you need to for this use-...(WOULD_IT_MAKE_SENSE)
[uncategorized] ~161-~161: Possible missing comma found.
Context: ...you to supply a ton of values for it to work or does it have reasonable defaults? #...(AI_HYDRA_LEO_MISSING_COMMA)
🪛 markdownlint-cli2 (0.17.2)
147-147: Heading levels should only increment by one level at a time
Expected: h3; Actual: h4(MD001, heading-increment)
🧹 Nitpick comments (5)
content/blog/oss-iac.md (5)
37-38
: Refine the introductory phrasing
The sentence “Outside of the few vendors that make our lives and the lives of our clients much easier…” could be simplified by dropping “of” after “Outside.”- Outside of the few vendors that make our lives and the lives of our clients much easier… + Outside the few vendors that make our lives and the lives of our clients much easier…🧰 Tools
🪛 LanguageTool
[uncategorized] ~37-~37: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...Intro At Masterpoint, we’re big on open source software (OSS). Outside of the few vend...(EN_COMPOUND_ADJECTIVE_INTERNAL)
[style] ~37-~37: This phrase is redundant. Consider using “Outside”.
Context: ... big on open source software (OSS). Outside of the few vendors that make our lives and...(OUTSIDE_OF)
38-39
: Insert missing comma after introductory clause
Add a comma after “For us” to improve readability.- For us that means using reusable, OSS modules for Terraform, OpenTofu, or Pulumi. + For us, that means using reusable, OSS modules for Terraform, OpenTofu, or Pulumi.🧰 Tools
🪛 LanguageTool
[formatting] ~39-~39: Insert a comma after “For us,”.
Context: ...ortant is Infrastructure as Code (IaC). For us that means using reusable, OSS modules ...(INTRODUCTORY_PHRASE_MISSING_COMMA)
23-23
: Unify quotation marks in TOC link text
The TOC item uses a curly opening quote but a straight closing quote. For consistency, use matching curly quotes around the text.- - [“Using external modules sounds like dependency hell"](#using-external-modules-sounds-like-dependency-hell) + - [“Using external modules sounds like dependency hell”](#using-external-modules-sounds-like-dependency-hell)
74-75
: Standardize unordered list style
markdownlint flags asterisks for list items here. Convert to dashes to match the rest of the document.- * run into a particular issue - * thought through it + - run into a particular issue + - thought through it🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
74-74: Unordered list style
Expected: dash; Actual: asterisk(MD004, ul-style)
75-75: Unordered list style
Expected: dash; Actual: asterisk(MD004, ul-style)
97-99
: Standardize unordered list style
Similarly, switch these asterisks to dashes.- * run into a particular issue - * thought through it - * and provided a fix or turnkey way to implement it + - run into a particular issue + - thought through it + - and provided a fix or turnkey way to implement it🧰 Tools
🪛 LanguageTool
[uncategorized] ~97-~97: This verb may not be in the correct tense. Consider changing the tense to fit the context better.
Context: ...r because the community has already: * run into a particular issue * thought throu...(AI_EN_LECTOR_REPLACEMENT_VERB_TENSE)
🪛 markdownlint-cli2 (0.17.2)
97-97: Unordered list style
Expected: dash; Actual: asterisk(MD004, ul-style)
98-98: Unordered list style
Expected: dash; Actual: asterisk(MD004, ul-style)
99-99: Unordered list style
Expected: dash; Actual: asterisk(MD004, ul-style)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting
📒 Files selected for processing (1)
content/blog/oss-iac.md
(1 hunks)
🧰 Additional context used
🪛 LanguageTool
content/blog/oss-iac.md
[uncategorized] ~37-~37: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...Intro At Masterpoint, we’re big on open source software (OSS). Outside of the few vend...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[style] ~37-~37: This phrase is redundant. Consider using “Outside”.
Context: ... big on open source software (OSS). Outside of the few vendors that make our lives and...
(OUTSIDE_OF)
[formatting] ~39-~39: Insert a comma after “For us,”.
Context: ...ortant is Infrastructure as Code (IaC). For us that means using reusable, OSS modules ...
(INTRODUCTORY_PHRASE_MISSING_COMMA)
[uncategorized] ~58-~58: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...e topics, we’ll share examples of solid open source modules. We’re biased towards [the amaz...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[style] ~58-~58: Consider using a more formal and expressive alternative to ‘amazing’.
Context: ...urce modules. We’re biased towards [the amazing module library](https://docs.cloudposse...
(AWESOME)
[style] ~62-~62: The verb “get” can be informal. Consider replacing it with a form of “to be”.
Context: ...ces There are many best practices that get built into OSS IaC modules, but I’ll focus on...
(GET_USED_ARE_USED)
[style] ~62-~62: As an alternative to the over-used intensifier ‘extremely’, consider replacing this phrase.
Context: ...modules, but I’ll focus on two that are extremely important: Naming + Tagging. {{< lightboximg "/i...
(EN_WEAK_ADJECTIVE)
[uncategorized] ~70-~70: These words/punctuation marks might seem a little out of order. For clarity and coherence, try switching them around.
Context: ...vironment. These components of the name also are built into the tags. By leveraging OSS...
(AI_EN_LECTOR_REPLACEMENT_WORD_ORDER)
[uncategorized] ~79-~79: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...C code. ### Security Hardened Because open source modules are being used by hundreds or t...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[uncategorized] ~81-~81: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ... bare minimum, those engineers need the open source module that they’re using to have setti...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[style] ~81-~81: The phrase ‘have the ability to’ might be wordy. Consider using “can”.
Context: ... requirements. This means that you also have the ability to configure these modules in a secure fas...
(HAS_THE_ABILITY_TO)
[style] ~81-~81: Consider replacing this phrase with the adverb “securely” to avoid wordiness.
Context: ... the ability to configure these modules in a secure fashion. At best, these developers upstream cod...
(IN_A_X_MANNER)
[uncategorized] ~85-~85: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...#L207-L233)). There are also plenty of open source modules that are scanned by security en...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[uncategorized] ~85-~85: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...v`. [We do this at Masterpoint with our open source modules](https://github.com/masterpoint...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[uncategorized] ~87-~87: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...u would upgrade your usage of the module and you’d then be more secure. Less work, m...
(COMMA_COMPOUND_SENTENCE)
[style] ~93-~93: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ... fix any bug that crops up. You’ll also need to add features; you might be the platform...
(REP_NEED_TO_VB)
[uncategorized] ~95-~95: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...ound the corner 😁). When you’re using open source modules, you often find exactly what yo...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[uncategorized] ~97-~97: This verb may not be in the correct tense. Consider changing the tense to fit the context better.
Context: ...r because the community has already: * run into a particular issue * thought throu...
(AI_EN_LECTOR_REPLACEMENT_VERB_TENSE)
[uncategorized] ~103-~103: A comma is probably missing here.
Context: ... of our projects and client work is. Of course we’re not the only ones! But when IPv6...
(MISSING_COMMA_AFTER_INTRODUCTORY_PHRASE)
[uncategorized] ~115-~115: The preposition “of” seems more likely in this position.
Context: ...ting codebase complexity. As an example for this reason to use OSS, let’s look at t...
(AI_EN_LECTOR_REPLACEMENT_PREPOSITION)
[uncategorized] ~121-~121: Possible missing comma found.
Context: ...ntain!) those 2K lines of code for your organization or for you to consume those 3 modules a...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~129-~129: Possible missing comma found.
Context: ....org/wiki/Leaky_abstraction)” This can happen and there are good examples of OSS modu...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~133-~133: Possible missing comma found.
Context: ...cific version, and update when you need to then you won’t run into the dependency ...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~137-~137: Possible missing comma found.
Context: ...reason” This is a sad reality for some folks and to those folks I suggest: Copy / pa...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~137-~137: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...those folks I suggest: Copy / pasta the open source module into your codebase, abiding by t...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[uncategorized] ~144-~144: Possible missing comma found.
Context: ...rden! ## How to evaluate good OSS IaC Above I suggest that you need to do your own ...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~149-~149: Use a comma before “or” if it connects two independent clauses (unless they are closely connected and short).
Context: ...t Does it default to support your needs or can you configure it to support your ne...
(COMMA_COMPOUND_SENTENCE_4)
[uncategorized] ~153-~153: Use a comma before “and” if it connects two independent clauses (unless they are closely connected and short).
Context: ...support Is your version of TF supported and can you use the module without upgradin...
(COMMA_COMPOUND_SENTENCE_4)
[style] ~153-~153: The expression “make sense” can be too colloquial for certain contexts. For a more formal tone, try using an alternative.
Context: ...n you use the module without upgrading? Does it make sense to upgrade if you need to for this use-...
(WOULD_IT_MAKE_SENSE)
[uncategorized] ~161-~161: Possible missing comma found.
Context: ...you to supply a ton of values for it to work or does it have reasonable defaults? #...
(AI_HYDRA_LEO_MISSING_COMMA)
[style] ~175-~175: You have already used ‘right’ in nearby sentences. Consider using an alternative word to let your writing stand out and sound more polished.
Context: ...elps you approach that process with the right mindset. To that end, if you want some...
(REP_RIGHT)
[uncategorized] ~177-~177: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...t. To that end, if you want some great open source module libraries to check out, start he...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
🪛 markdownlint-cli2 (0.17.2)
content/blog/oss-iac.md
74-74: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
75-75: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
97-97: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
98-98: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
99-99: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
127-127: Heading levels should only increment by one level at a time
Expected: h3; Actual: h4
(MD001, heading-increment)
147-147: Heading levels should only increment by one level at a time
Expected: h3; Actual: h4
(MD001, heading-increment)
⏰ Context from checks skipped due to timeout of 90000ms (3)
- GitHub Check: Redirect rules - masterpoint
- GitHub Check: Header rules - masterpoint
- GitHub Check: Pages changed - masterpoint
🔇 Additional comments (1)
content/blog/oss-iac.md (1)
1-11
: Front matter looks solid
The YAML metadata (visibility, title, author, slug, date, etc.) is correctly formatted and complete.
Co-authored-by: Veronika Gnilitska <30597968+gberenice@users.noreply.github.com> Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
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: 1
♻️ Duplicate comments (1)
content/blog/oss-iac.md (1)
127-142
: Normalize heading levels in Objections section
Subheadings under “Objections to open source IaC” should be H3 (###
), not H4 (####
), to maintain proper structure and TOC nesting.- #### “There are too many inputs to so-and-so module – [it feels like a leaky abstraction]… - #### “Using external modules sounds like dependency hell” - #### “We can’t use open-source in my organization because of XYZ reason” - #### “But I can generate all this IaC with AI… why wouldn’t I do that?” + ### “There are too many inputs to so-and-so module – [it feels like a leaky abstraction]… + ### “Using external modules sounds like dependency hell” + ### “We can’t use open-source in my organization because of XYZ reason” + ### “But I can generate all this IaC with AI… why wouldn’t I do that?”🧰 Tools
🪛 LanguageTool
[uncategorized] ~129-~129: Possible missing comma found.
Context: ....org/wiki/Leaky_abstraction)” This can happen and there are good examples of OSS modu...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~137-~137: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...those folks I suggest: Copy / pasta the open source module into your codebase, abiding by t...(EN_COMPOUND_ADJECTIVE_INTERNAL)
🪛 markdownlint-cli2 (0.17.2)
127-127: Heading levels should only increment by one level at a time
Expected: h3; Actual: h4(MD001, heading-increment)
🧹 Nitpick comments (4)
content/blog/oss-iac.md (4)
39-39
: Add missing comma after introductory phrase
Per English grammar, introductory adverbial phrases like “For us” should be followed by a comma.- One big area where this is critically important is Infrastructure as Code (IaC). For us that means using reusable, OSS modules... + One big area where this is critically important is Infrastructure as Code (IaC). For us, that means using reusable, OSS modules...🧰 Tools
🪛 LanguageTool
[formatting] ~39-~39: Insert a comma after “For us,”.
Context: ...ortant is Infrastructure as Code (IaC). For us that means using reusable, OSS modules ...(INTRODUCTORY_PHRASE_MISSING_COMMA)
62-62
: Convert passive “get built into” to active voice
Replace “get built into OSS IaC modules” with “are built into OSS IaC modules” for clarity.- There are many best practices that get built into OSS IaC modules... + There are many best practices that are built into OSS IaC modules...🧰 Tools
🪛 LanguageTool
[style] ~62-~62: The verb “get” can be informal. Consider replacing it with a form of “to be”.
Context: ...ces There are many best practices that get built into OSS IaC modules, but I’ll focus on...(GET_USED_ARE_USED)
[style] ~62-~62: As an alternative to the over-used intensifier ‘extremely’, consider replacing this phrase.
Context: ...modules, but I’ll focus on two that are extremely important: Naming + Tagging. {{< lightboximg "/i...(EN_WEAK_ADJECTIVE)
74-75
: Unify unordered list marker style
The file mixes*
and-
for bullet lists. Standardize on-
for consistency (per markdownlint).- * Your code that uses the modules gets the best practices… - * You can look to these modules for inspiration… + - Your code that uses the modules gets the best practices… + - You can look to these modules for inspiration… - * run into a particular issue - * thought through it - * and provided a fix or turnkey way to implement it + - run into a particular issue + - thought through it + - and provided a fix or turnkey way to implement itAlso applies to: 98-100
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
74-74: Unordered list style
Expected: dash; Actual: asterisk(MD004, ul-style)
75-75: Unordered list style
Expected: dash; Actual: asterisk(MD004, ul-style)
142-142
: Consider adding an objection on malicious code
Security-conscious audiences often worry about untrusted code. You could insert an objection like:+ ### “Open source modules could contain malicious code” + While rare, malicious pull requests or package typosquatting can introduce vulnerabilities. Always scan modules with tools like Trivy or Checkov, pin to vetted releases, and review change logs before upgrading.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting
📒 Files selected for processing (1)
content/blog/oss-iac.md
(1 hunks)
🧰 Additional context used
🪛 LanguageTool
content/blog/oss-iac.md
[uncategorized] ~37-~37: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...Intro At Masterpoint, we’re big on open source software (OSS). Outside of the few vend...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[style] ~37-~37: This phrase is redundant. Consider using “Outside”.
Context: ... big on open source software (OSS). Outside of the few vendors that make our lives and...
(OUTSIDE_OF)
[formatting] ~39-~39: Insert a comma after “For us,”.
Context: ...ortant is Infrastructure as Code (IaC). For us that means using reusable, OSS modules ...
(INTRODUCTORY_PHRASE_MISSING_COMMA)
[uncategorized] ~58-~58: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...e topics, we’ll share examples of solid open source modules. We’re biased towards [the amaz...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[style] ~58-~58: Consider using a more formal and expressive alternative to ‘amazing’.
Context: ...urce modules. We’re biased towards [the amazing module library](https://docs.cloudposse...
(AWESOME)
[style] ~62-~62: The verb “get” can be informal. Consider replacing it with a form of “to be”.
Context: ...ces There are many best practices that get built into OSS IaC modules, but I’ll focus on...
(GET_USED_ARE_USED)
[style] ~62-~62: As an alternative to the over-used intensifier ‘extremely’, consider replacing this phrase.
Context: ...modules, but I’ll focus on two that are extremely important: Naming + Tagging. {{< lightboximg "/i...
(EN_WEAK_ADJECTIVE)
[uncategorized] ~70-~70: These words/punctuation marks might seem a little out of order. For clarity and coherence, try switching them around.
Context: ...vironment. These components of the name also are built into the tags. By leveraging OSS...
(AI_EN_LECTOR_REPLACEMENT_WORD_ORDER)
[uncategorized] ~79-~79: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...C code. ### Security Hardened Because open source modules are being used by hundreds or t...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[uncategorized] ~81-~81: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ... bare minimum, those engineers need the open source module that they’re using to have setti...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[style] ~81-~81: The phrase ‘have the ability to’ might be wordy. Consider using “can”.
Context: ... requirements. This means that you also have the ability to configure these modules in a secure fas...
(HAS_THE_ABILITY_TO)
[style] ~81-~81: Consider replacing this phrase with the adverb “securely” to avoid wordiness.
Context: ... the ability to configure these modules in a secure fashion. At best, these developers upstream cod...
(IN_A_X_MANNER)
[uncategorized] ~85-~85: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...#L207-L233)). There are also plenty of open source modules that are scanned by security en...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[uncategorized] ~85-~85: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...v`. [We do this at Masterpoint with our open source modules](https://github.com/masterpoint...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[uncategorized] ~87-~87: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...u would upgrade your usage of the module and you’d then be more secure. Less work, m...
(COMMA_COMPOUND_SENTENCE)
[style] ~93-~93: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ... fix any bug that crops up. You’ll also need to add features; you might be the platform...
(REP_NEED_TO_VB)
[uncategorized] ~95-~95: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...ound the corner 😁). When you’re using open source modules, you often find exactly what yo...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[uncategorized] ~97-~97: This verb may not be in the correct tense. Consider changing the tense to fit the context better.
Context: ...r because the community has already: * run into a particular issue * thought throu...
(AI_EN_LECTOR_REPLACEMENT_VERB_TENSE)
[uncategorized] ~103-~103: A comma is probably missing here.
Context: ... of our projects and client work is. Of course we’re not the only ones! But when IPv6...
(MISSING_COMMA_AFTER_INTRODUCTORY_PHRASE)
[uncategorized] ~115-~115: The preposition “of” seems more likely in this position.
Context: ...ting codebase complexity. As an example for this reason to use OSS, let’s look at t...
(AI_EN_LECTOR_REPLACEMENT_PREPOSITION)
[uncategorized] ~129-~129: Possible missing comma found.
Context: ....org/wiki/Leaky_abstraction)” This can happen and there are good examples of OSS modu...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~137-~137: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...those folks I suggest: Copy / pasta the open source module into your codebase, abiding by t...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[uncategorized] ~144-~144: Possible missing comma found.
Context: ...rden! ## How to evaluate good OSS IaC Above I suggest that you need to do your own ...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~149-~149: Use a comma before “or” if it connects two independent clauses (unless they are closely connected and short).
Context: ...t Does it default to support your needs or can you configure it to support your ne...
(COMMA_COMPOUND_SENTENCE_4)
[uncategorized] ~153-~153: Use a comma before “and” if it connects two independent clauses (unless they are closely connected and short).
Context: ...support Is your version of TF supported and can you use the module without upgradin...
(COMMA_COMPOUND_SENTENCE_4)
[style] ~153-~153: The expression “make sense” can be too colloquial for certain contexts. For a more formal tone, try using an alternative.
Context: ...n you use the module without upgrading? Does it make sense to upgrade if you need to for this use-...
(WOULD_IT_MAKE_SENSE)
[uncategorized] ~161-~161: Possible missing comma found.
Context: ...you to supply a ton of values for it to work or does it have reasonable defaults? #...
(AI_HYDRA_LEO_MISSING_COMMA)
[style] ~175-~175: You have already used ‘right’ in nearby sentences. Consider using an alternative word to let your writing stand out and sound more polished.
Context: ...elps you approach that process with the right mindset. To that end, if you want some...
(REP_RIGHT)
[uncategorized] ~177-~177: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...t. To that end, if you want some great open source module libraries to check out, start he...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
🪛 markdownlint-cli2 (0.17.2)
content/blog/oss-iac.md
74-74: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
75-75: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
97-97: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
98-98: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
99-99: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
127-127: Heading levels should only increment by one level at a time
Expected: h3; Actual: h4
(MD001, heading-increment)
⏰ Context from checks skipped due to timeout of 90000ms (3)
- GitHub Check: Redirect rules - masterpoint
- GitHub Check: Header rules - masterpoint
- GitHub Check: Pages changed - masterpoint
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
🔭 Outside diff range comments (1)
content/blog/oss-iac.md (1)
1-191
:⚠️ Potential issuePrettier formatting issues detected.
The file failed thetrunk fmt
check (Prettier). Please runtrunk fmt
to automatically format the Markdown and satisfy the formatting checks before merging.🧰 Tools
🪛 LanguageTool
[uncategorized] ~37-~37: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...Intro At Masterpoint, we're big on open source software (OSS). Outside of the few vend...(EN_COMPOUND_ADJECTIVE_INTERNAL)
[style] ~37-~37: This phrase is redundant. Consider using “Outside”.
Context: ... big on open source software (OSS). Outside of the few vendors that make our lives and...(OUTSIDE_OF)
[formatting] ~39-~39: Insert a comma after “For us,”.
Context: ...ortant is Infrastructure as Code (IaC). For us that means using reusable, OSS modules ...(INTRODUCTORY_PHRASE_MISSING_COMMA)
[uncategorized] ~58-~58: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...e topics, we'll share examples of solid open source modules. We're biased towards [the amaz...(EN_COMPOUND_ADJECTIVE_INTERNAL)
[style] ~58-~58: Consider using a more formal and expressive alternative to ‘amazing’.
Context: ...urce modules. We're biased towards [the amazing module library](https://docs.cloudposse...(AWESOME)
[style] ~62-~62: The verb “get” can be informal. Consider replacing it with a form of “to be”.
Context: ...ces There are many best practices that get built into OSS IaC modules, but I'll focus on...(GET_USED_ARE_USED)
[style] ~62-~62: As an alternative to the over-used intensifier ‘extremely’, consider replacing this phrase.
Context: ...modules, but I'll focus on two that are extremely important: Naming + Tagging. {{< lightboximg "/i...(EN_WEAK_ADJECTIVE)
[uncategorized] ~70-~70: These words/punctuation marks might seem a little out of order. For clarity and coherence, try switching them around.
Context: ...vironment. These components of the name also are built into the tags. By leveraging OSS...(AI_EN_LECTOR_REPLACEMENT_WORD_ORDER)
[uncategorized] ~79-~79: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...C code. ### Security Hardened Because open source modules are being used by hundreds or t...(EN_COMPOUND_ADJECTIVE_INTERNAL)
[uncategorized] ~81-~81: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ... bare minimum, those engineers need the open source module that they're using to have setti...(EN_COMPOUND_ADJECTIVE_INTERNAL)
[style] ~81-~81: The phrase ‘have the ability to’ might be wordy. Consider using “can”.
Context: ... requirements. This means that you also have the ability to configure these modules in a secure fas...(HAS_THE_ABILITY_TO)
[style] ~81-~81: Consider replacing this phrase with the adverb “securely” to avoid wordiness.
Context: ... the ability to configure these modules in a secure fashion. At best, these developers upstream cod...(IN_A_X_MANNER)
[uncategorized] ~85-~85: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...#L207-L233)). There are also plenty of open source modules that are scanned by security en...(EN_COMPOUND_ADJECTIVE_INTERNAL)
[uncategorized] ~85-~85: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...v`. [We do this at Masterpoint with our open source modules](https://github.com/masterpoint...(EN_COMPOUND_ADJECTIVE_INTERNAL)
[uncategorized] ~87-~87: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...u would upgrade your usage of the module and you'd then be more secure. Less work, m...(COMMA_COMPOUND_SENTENCE)
[style] ~93-~93: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ... fix any bug that crops up. You'll also need to add features; you might be the platform...(REP_NEED_TO_VB)
[uncategorized] ~95-~95: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...ound the corner 😁). When you're using open source modules, you often find exactly what yo...(EN_COMPOUND_ADJECTIVE_INTERNAL)
[uncategorized] ~97-~97: This verb may not be in the correct tense. Consider changing the tense to fit the context better.
Context: ...r because the community has already: * run into a particular issue * thought throu...(AI_EN_LECTOR_REPLACEMENT_VERB_TENSE)
[uncategorized] ~103-~103: A comma is probably missing here.
Context: ... of our projects and client work is. Of course we're not the only ones! But when IPv6...(MISSING_COMMA_AFTER_INTRODUCTORY_PHRASE)
[uncategorized] ~115-~115: The preposition “of” seems more likely in this position.
Context: ...ting codebase complexity. As an example for this reason to use OSS, let's look at t...(AI_EN_LECTOR_REPLACEMENT_PREPOSITION)
[uncategorized] ~121-~121: Possible missing comma found.
Context: ...ntain!) those 2K lines of code for your organization or for you to consume those 3 modules a...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~129-~129: Possible missing comma found.
Context: ....org/wiki/Leaky_abstraction)” This can happen and there are good examples of OSS modu...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~133-~133: Possible missing comma found.
Context: ...cific version, and update when you need to then you won't run into the dependency ...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~137-~137: Possible missing comma found.
Context: ...reason” This is a sad reality for some folks and to those folks I suggest: Copy / pa...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~137-~137: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...those folks I suggest: Copy / pasta the open source module into your codebase, abiding by t...(EN_COMPOUND_ADJECTIVE_INTERNAL)
[uncategorized] ~148-~148: Possible missing comma found.
Context: ...rden! ## How to evaluate good OSS IaC Above I suggest that you need to do your own ...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~157-~157: Use a comma before “or” if it connects two independent clauses (unless they are closely connected and short).
Context: ...t Does it default to support your needs or can you configure it to support your ne...(COMMA_COMPOUND_SENTENCE_4)
[uncategorized] ~161-~161: Use a comma before “and” if it connects two independent clauses (unless they are closely connected and short).
Context: ...support Is your version of TF supported and can you use the module without upgradin...(COMMA_COMPOUND_SENTENCE_4)
[style] ~161-~161: The expression “make sense” can be too colloquial for certain contexts. For a more formal tone, try using an alternative.
Context: ...n you use the module without upgrading? Does it make sense to upgrade if you need to for this use-...(WOULD_IT_MAKE_SENSE)
[style] ~183-~183: You have already used ‘right’ in nearby sentences. Consider using an alternative word to let your writing stand out and sound more polished.
Context: ...elps you approach that process with the right mindset. To that end, if you want some...(REP_RIGHT)
[uncategorized] ~185-~185: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...t. To that end, if you want some great open source module libraries to check out, start he...(EN_COMPOUND_ADJECTIVE_INTERNAL)
🪛 GitHub Check: Trunk Check
[failure] 1-1: prettier
Incorrect formatting, autoformat by running 'trunk fmt'
♻️ Duplicate comments (1)
content/blog/oss-iac.md (1)
23-23
:⚠️ Potential issueFix mismatched and inconsistent quotation marks in TOC link.
The second objection link uses an opening curly quote and a straight closing quote. It should be revised as follows for typographic consistency:- - [“Using external modules sounds like dependency hell"](#using-external-modules-sounds-like-dependency-hell) + - [“Using external modules sounds like dependency hell”](#using-external-modules-sounds-like-dependency-hell)
🧹 Nitpick comments (2)
content/blog/oss-iac.md (2)
13-14
: Use Markdown heading for consistency.
Instead of raw HTML (<h2>Table of Contents</h2>
), consider using a Markdown heading (## Table of Contents
) to maintain consistency with the rest of the document and improve readability.
38-39
: Add missing comma after introductory phrase.
To improve readability, insert a comma after "For us":- One big area where this is critically important is Infrastructure as Code (IaC). For us that means using reusable, OSS modules for Terraform, OpenTofu, or Pulumi. + One big area where this is critically important is Infrastructure as Code (IaC). For us, that means using reusable, OSS modules for Terraform, OpenTofu, or Pulumi.🧰 Tools
🪛 LanguageTool
[formatting] ~39-~39: Insert a comma after “For us,”.
Context: ...ortant is Infrastructure as Code (IaC). For us that means using reusable, OSS modules ...(INTRODUCTORY_PHRASE_MISSING_COMMA)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
content/blog/oss-iac.md
(1 hunks)
🧰 Additional context used
🪛 LanguageTool
content/blog/oss-iac.md
[uncategorized] ~37-~37: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...Intro At Masterpoint, we're big on open source software (OSS). Outside of the few vend...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[style] ~37-~37: This phrase is redundant. Consider using “Outside”.
Context: ... big on open source software (OSS). Outside of the few vendors that make our lives and...
(OUTSIDE_OF)
[formatting] ~39-~39: Insert a comma after “For us,”.
Context: ...ortant is Infrastructure as Code (IaC). For us that means using reusable, OSS modules ...
(INTRODUCTORY_PHRASE_MISSING_COMMA)
[uncategorized] ~58-~58: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...e topics, we'll share examples of solid open source modules. We're biased towards [the amaz...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[style] ~58-~58: Consider using a more formal and expressive alternative to ‘amazing’.
Context: ...urce modules. We're biased towards [the amazing module library](https://docs.cloudposse...
(AWESOME)
[style] ~62-~62: The verb “get” can be informal. Consider replacing it with a form of “to be”.
Context: ...ces There are many best practices that get built into OSS IaC modules, but I'll focus on...
(GET_USED_ARE_USED)
[style] ~62-~62: As an alternative to the over-used intensifier ‘extremely’, consider replacing this phrase.
Context: ...modules, but I'll focus on two that are extremely important: Naming + Tagging. {{< lightboximg "/i...
(EN_WEAK_ADJECTIVE)
[uncategorized] ~70-~70: These words/punctuation marks might seem a little out of order. For clarity and coherence, try switching them around.
Context: ...vironment. These components of the name also are built into the tags. By leveraging OSS...
(AI_EN_LECTOR_REPLACEMENT_WORD_ORDER)
[uncategorized] ~79-~79: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...C code. ### Security Hardened Because open source modules are being used by hundreds or t...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[uncategorized] ~81-~81: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ... bare minimum, those engineers need the open source module that they're using to have setti...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[style] ~81-~81: The phrase ‘have the ability to’ might be wordy. Consider using “can”.
Context: ... requirements. This means that you also have the ability to configure these modules in a secure fas...
(HAS_THE_ABILITY_TO)
[style] ~81-~81: Consider replacing this phrase with the adverb “securely” to avoid wordiness.
Context: ... the ability to configure these modules in a secure fashion. At best, these developers upstream cod...
(IN_A_X_MANNER)
[uncategorized] ~85-~85: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...#L207-L233)). There are also plenty of open source modules that are scanned by security en...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[uncategorized] ~85-~85: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...v`. [We do this at Masterpoint with our open source modules](https://github.com/masterpoint...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[uncategorized] ~87-~87: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...u would upgrade your usage of the module and you'd then be more secure. Less work, m...
(COMMA_COMPOUND_SENTENCE)
[style] ~93-~93: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ... fix any bug that crops up. You'll also need to add features; you might be the platform...
(REP_NEED_TO_VB)
[uncategorized] ~95-~95: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...ound the corner 😁). When you're using open source modules, you often find exactly what yo...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[uncategorized] ~97-~97: This verb may not be in the correct tense. Consider changing the tense to fit the context better.
Context: ...r because the community has already: * run into a particular issue * thought throu...
(AI_EN_LECTOR_REPLACEMENT_VERB_TENSE)
[uncategorized] ~103-~103: A comma is probably missing here.
Context: ... of our projects and client work is. Of course we're not the only ones! But when IPv6...
(MISSING_COMMA_AFTER_INTRODUCTORY_PHRASE)
[uncategorized] ~115-~115: The preposition “of” seems more likely in this position.
Context: ...ting codebase complexity. As an example for this reason to use OSS, let's look at t...
(AI_EN_LECTOR_REPLACEMENT_PREPOSITION)
[uncategorized] ~121-~121: Possible missing comma found.
Context: ...ntain!) those 2K lines of code for your organization or for you to consume those 3 modules a...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~129-~129: Possible missing comma found.
Context: ....org/wiki/Leaky_abstraction)” This can happen and there are good examples of OSS modu...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~133-~133: Possible missing comma found.
Context: ...cific version, and update when you need to then you won't run into the dependency ...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~137-~137: Possible missing comma found.
Context: ...reason” This is a sad reality for some folks and to those folks I suggest: Copy / pa...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~137-~137: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...those folks I suggest: Copy / pasta the open source module into your codebase, abiding by t...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[uncategorized] ~148-~148: Possible missing comma found.
Context: ...rden! ## How to evaluate good OSS IaC Above I suggest that you need to do your own ...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~157-~157: Use a comma before “or” if it connects two independent clauses (unless they are closely connected and short).
Context: ...t Does it default to support your needs or can you configure it to support your ne...
(COMMA_COMPOUND_SENTENCE_4)
[uncategorized] ~161-~161: Use a comma before “and” if it connects two independent clauses (unless they are closely connected and short).
Context: ...support Is your version of TF supported and can you use the module without upgradin...
(COMMA_COMPOUND_SENTENCE_4)
[style] ~161-~161: The expression “make sense” can be too colloquial for certain contexts. For a more formal tone, try using an alternative.
Context: ...n you use the module without upgrading? Does it make sense to upgrade if you need to for this use-...
(WOULD_IT_MAKE_SENSE)
[style] ~183-~183: You have already used ‘right’ in nearby sentences. Consider using an alternative word to let your writing stand out and sound more polished.
Context: ...elps you approach that process with the right mindset. To that end, if you want some...
(REP_RIGHT)
[uncategorized] ~185-~185: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...t. To that end, if you want some great open source module libraries to check out, start he...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
🪛 GitHub Check: Trunk Check
content/blog/oss-iac.md
[failure] 1-1: prettier
Incorrect formatting, autoformat by running 'trunk fmt'
⏰ Context from checks skipped due to timeout of 90000ms (3)
- GitHub Check: Redirect rules - masterpoint
- GitHub Check: Header rules - masterpoint
- GitHub Check: Pages changed - masterpoint
🔇 Additional comments (1)
content/blog/oss-iac.md (1)
1-11
: Front matter is correctly configured.
YAML front matter includes all required fields (visible, draft, title, author, slug, date, description, image, callout) and appears valid.🧰 Tools
🪛 GitHub Check: Trunk Check
[failure] 1-1: prettier
Incorrect formatting, autoformat by running 'trunk fmt'
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.
I have a strong feeling that I already reviewed this before, but I don't see my comments 😆
A couple of tiny suggestions!
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
♻️ Duplicate comments (1)
content/blog/oss-iac.md (1)
23-23
:⚠️ Potential issueFix mismatched quote in Table of Contents entry
The closing quotation mark and square bracket are swapped, which will break the Markdown link.- - [“Using external modules sounds like dependency hell"](#using-external-modules-sounds-like-dependency-hell) + - [“Using external modules sounds like dependency hell”](#using-external-modules-sounds-like-dependency-hell)
🧹 Nitpick comments (3)
content/blog/oss-iac.md (3)
39-39
: Hyphenate compound adjective “open-source software”
Use a hyphen for compound adjectives modifying a noun for consistency and clarity.-At Masterpoint, we're **big** on open source software (OSS). +At Masterpoint, we're **big** on open-source software (OSS).🧰 Tools
🪛 LanguageTool
[uncategorized] ~39-~39: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...Intro At Masterpoint, we're big on open source software (OSS). Outside of the few vend...(EN_COMPOUND_ADJECTIVE_INTERNAL)
[style] ~39-~39: This phrase is redundant. Consider using “Outside”.
Context: ... big on open source software (OSS). Outside of the few vendors that make our lives and...(OUTSIDE_OF)
41-41
: Insert missing comma after introductory phrase
Add a comma after “For us” to separate the introductory phrase.-One big area where this is critically important is Infrastructure as Code (IaC). For us that means using reusable, OSS modules for Terraform, OpenTofu, or Pulumi. +One big area where this is critically important is Infrastructure as Code (IaC). For us, that means using reusable, OSS modules for Terraform, OpenTofu, or Pulumi.🧰 Tools
🪛 LanguageTool
[formatting] ~41-~41: Insert a comma after “For us,”.
Context: ...ortant is Infrastructure as Code (IaC). For us that means using reusable, OSS modules ...(INTRODUCTORY_PHRASE_MISSING_COMMA)
64-64
: Clarify wording: replace “get built into”
Use “are built into” instead of the more informal “get built into” for a smoother read.-There are many best practices that get built into OSS IaC modules, but I'll focus on two that are extremely important: Naming + Tagging. +There are many best practices that are built into OSS IaC modules, but I'll focus on two that are extremely important: Naming + Tagging.🧰 Tools
🪛 LanguageTool
[style] ~64-~64: The verb “get” can be informal. Consider replacing it with a form of “to be”.
Context: ...ces There are many best practices that get built into OSS IaC modules, but I'll focus on...(GET_USED_ARE_USED)
[style] ~64-~64: As an alternative to the over-used intensifier ‘extremely’, consider replacing this phrase.
Context: ...modules, but I'll focus on two that are extremely important: Naming + Tagging. {{< lightboximg "/i...(EN_WEAK_ADJECTIVE)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (2)
static/img/updates/oss-iac/naming-hard.png
is excluded by!**/*.png
static/img/updates/oss-iac/oss-iac.png
is excluded by!**/*.png
📒 Files selected for processing (2)
.github/CODEOWNERS
(1 hunks)content/blog/oss-iac.md
(1 hunks)
✅ Files skipped from review due to trivial changes (1)
- .github/CODEOWNERS
🧰 Additional context used
🪛 LanguageTool
content/blog/oss-iac.md
[uncategorized] ~39-~39: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...Intro At Masterpoint, we're big on open source software (OSS). Outside of the few vend...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[style] ~39-~39: This phrase is redundant. Consider using “Outside”.
Context: ... big on open source software (OSS). Outside of the few vendors that make our lives and...
(OUTSIDE_OF)
[formatting] ~41-~41: Insert a comma after “For us,”.
Context: ...ortant is Infrastructure as Code (IaC). For us that means using reusable, OSS modules ...
(INTRODUCTORY_PHRASE_MISSING_COMMA)
[uncategorized] ~60-~60: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...e topics, we'll share examples of solid open source modules. We're biased towards [the amaz...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[style] ~60-~60: Consider using a more formal and expressive alternative to ‘amazing’.
Context: ...urce modules. We're biased towards [the amazing module library](https://docs.cloudposse...
(AWESOME)
[style] ~64-~64: The verb “get” can be informal. Consider replacing it with a form of “to be”.
Context: ...ces There are many best practices that get built into OSS IaC modules, but I'll focus on...
(GET_USED_ARE_USED)
[style] ~64-~64: As an alternative to the over-used intensifier ‘extremely’, consider replacing this phrase.
Context: ...modules, but I'll focus on two that are extremely important: Naming + Tagging. {{< lightboximg "/i...
(EN_WEAK_ADJECTIVE)
[uncategorized] ~81-~81: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...C code. ### Security Hardened Because open source modules are being used by hundreds or t...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[uncategorized] ~83-~83: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ... bare minimum, those engineers need the open source module that they're using to have setti...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[style] ~83-~83: The phrase ‘have the ability to’ might be wordy. Consider using “can”.
Context: ... requirements. This means that you also have the ability to configure these modules in a secure fas...
(HAS_THE_ABILITY_TO)
[style] ~83-~83: Consider replacing this phrase with the adverb “securely” to avoid wordiness.
Context: ... the ability to configure these modules in a secure fashion. At best, these developers upstream cod...
(IN_A_X_MANNER)
[uncategorized] ~87-~87: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...#L207-L233)). There are also plenty of open source modules that are scanned by security en...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[uncategorized] ~87-~87: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...v`. [We do this at Masterpoint with our open source modules](https://github.com/masterpoint...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[uncategorized] ~89-~89: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...u would upgrade your usage of the module and you'd then be more secure. Less work, m...
(COMMA_COMPOUND_SENTENCE)
[style] ~95-~95: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ... fix any bug that crops up. You'll also need to add features; you might be the platform...
(REP_NEED_TO_VB)
[uncategorized] ~97-~97: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...ound the corner 😁). When you're using open source modules, you often find exactly what yo...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[uncategorized] ~105-~105: A comma is probably missing here.
Context: ... of our projects and client work is. Of course we're not the only ones! But when IPv6...
(MISSING_COMMA_AFTER_INTRODUCTORY_PHRASE)
[uncategorized] ~123-~123: Possible missing comma found.
Context: ...ntain!) those 2K lines of code for your organization or for you to consume those 3 modules a...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~131-~131: Possible missing comma found.
Context: ....org/wiki/Leaky_abstraction)” This can happen and there are good examples of OSS modu...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~135-~135: Possible missing comma found.
Context: ...cific version, and update when you need to then you won't run into the dependency ...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~139-~139: Possible missing comma found.
Context: ...reason” This is a sad reality for some folks and to those folks I suggest: Copy / pa...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~139-~139: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...those folks I suggest: Copy / pasta the open source module into your codebase, abiding by t...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[uncategorized] ~150-~150: Possible missing comma found.
Context: ...rden! ## How to evaluate good OSS IaC Above I suggest that you need to do your own ...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~159-~159: Use a comma before “or” if it connects two independent clauses (unless they are closely connected and short).
Context: ...t Does it default to support your needs or can you configure it to support your ne...
(COMMA_COMPOUND_SENTENCE_4)
[uncategorized] ~163-~163: Use a comma before “and” if it connects two independent clauses (unless they are closely connected and short).
Context: ...support Is your version of TF supported and can you use the module without upgradin...
(COMMA_COMPOUND_SENTENCE_4)
[style] ~163-~163: The expression “make sense” can be too colloquial for certain contexts. For a more formal tone, try using an alternative.
Context: ...n you use the module without upgrading? Does it make sense to upgrade if you need to for this use-...
(WOULD_IT_MAKE_SENSE)
[uncategorized] ~171-~171: Possible missing comma found.
Context: ...you to supply a ton of values for it to work or does it have reasonable defaults? #...
(AI_HYDRA_LEO_MISSING_COMMA)
[style] ~185-~185: You have already used ‘right’ in nearby sentences. Consider using an alternative word to let your writing stand out and sound more polished.
Context: ...elps you approach that process with the right mindset. To that end, if you want some...
(REP_RIGHT)
[uncategorized] ~187-~187: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...t. To that end, if you want some great open source module libraries to check out, start he...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
⏰ Context from checks skipped due to timeout of 90000ms (3)
- GitHub Check: Redirect rules - masterpoint
- GitHub Check: Header rules - masterpoint
- GitHub Check: Pages changed - masterpoint
what
why
references
Summary by CodeRabbit