-
-
Notifications
You must be signed in to change notification settings - Fork 107
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
Support and About command implementation #909
Conversation
📝 WalkthroughWalkthroughThis pull request introduces two new CLI commands, Changes
Assessment against linked issues
Possibly related PRs
Suggested labels
Suggested reviewers
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
Documentation and Community
|
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 (6)
cmd/about.go (1)
29-34
: Validate markdown content.
Consider adding a fallback message ifaboutMarkdown
is empty. This can improve user experience if embedding fails unexpectedly.if err != nil { return fmt.Errorf("failed to render about documentation: %w", err) } + +if len(aboutMarkdown) == 0 { + fmt.Fprintln(os.Stdout, "About information not found.") + return nil +} fmt.Fprint(os.Stdout, out)cmd/support.go (1)
29-34
: Improve user feedback for empty or missing content.
Same idea: add a check for emptysupportMarkdown
.if err != nil { return fmt.Errorf("failed to render support documentation: %w", err) } + +if len(supportMarkdown) == 0 { + fmt.Fprintln(os.Stdout, "Support information not found.") + return nil +} fmt.Fprint(os.Stdout, out)cmd/markdown/support.md (2)
19-19
: Use proper markdown links instead of bare URLs.
Avoid bare URLs to comply with lint rules. Link text fosters clarity.-https://github.com/sponsors/cloudposse +[GitHub Sponsors](https://github.com/sponsors/cloudposse)-> https://github.com/sponsors/cloudposse +> [GitHub Sponsors](https://github.com/sponsors/cloudposse)Also applies to: 29-29
🧰 Tools
🪛 Markdownlint (0.37.0)
19-19: null
Bare URL used(MD034, no-bare-urls)
29-29
: Remove multiple spaces after blockquote.
Remediate the markdownlint MD027 warning by using a single space.-> **Note**: Paid support includes priority responses. -> https://github.com/sponsors/cloudposse +> **Note**: Paid support includes priority responses. +> [GitHub Sponsors](https://github.com/sponsors/cloudposse)🧰 Tools
🪛 Markdownlint (0.37.0)
29-29: null
Multiple spaces after blockquote symbol(MD027, no-multiple-space-blockquote)
29-29: null
Bare URL used(MD034, no-bare-urls)
cmd/markdown/about.md (2)
16-16
: Consider spelling "multi-environment" as one word.
This addresses the language tool suggestion.-**Scalable**: Designed for multi-account, multi-environment AWS setups. +**Scalable**: Designed for multi-account, multienvironment AWS setups.🧰 Tools
🪛 LanguageTool
[misspelling] ~16-~16: This word is normally spelled as one.
Context: ...Scalable**: Designed for multi-account, multi-environment AWS setups. ## Why Atmos? Atmos reduce...(EN_COMPOUNDS_MULTI_ENVIRONMENT)
22-22
: Use a proper markdown link.
Mitigates bare URL usage (MD034).-Learn more at https://atmos.tools +Learn more at [atmos.tools](https://atmos.tools)🧰 Tools
🪛 Markdownlint (0.37.0)
22-22: null
Bare URL used(MD034, no-bare-urls)
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (4)
cmd/about.go
(1 hunks)cmd/markdown/about.md
(1 hunks)cmd/markdown/support.md
(1 hunks)cmd/support.go
(1 hunks)
🧰 Additional context used
🪛 Markdownlint (0.37.0)
cmd/markdown/support.md
29-29: null
Multiple spaces after blockquote symbol
(MD027, no-multiple-space-blockquote)
19-19: null
Bare URL used
(MD034, no-bare-urls)
29-29: null
Bare URL used
(MD034, no-bare-urls)
cmd/markdown/about.md
22-22: null
Bare URL used
(MD034, no-bare-urls)
🪛 LanguageTool
cmd/markdown/about.md
[misspelling] ~16-~16: This word is normally spelled as one.
Context: ...Scalable**: Designed for multi-account, multi-environment AWS setups. ## Why Atmos? Atmos reduce...
(EN_COMPOUNDS_MULTI_ENVIRONMENT)
🔇 Additional comments (4)
cmd/about.go (2)
16-19
: Command definition looks good.
Implementation is straightforward. The short description and usage instructions are concise.
21-24
: Renderer creation is robust.
Looks good. Glamour is configured with auto-detection and an appropriate wrap width, ensuring readable CL output.cmd/support.go (2)
16-19
: Command definition is consistent.
Implementation aligns well with the approach used in about.go.
21-24
: Renderer usage is consistent.
Same approach asaboutCmd
. This consistency is good for maintainability.
Is there a way we can prevent markdown links without anchor text from getting duplicated? |
Thanks @osterman here is the changes you pushed |
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)
cmd/markdown/support.md (1)
19-19
: 🛠️ Refactor suggestionRemove duplicate sponsor links and fix blockquote formatting.
- The GitHub sponsors link appears twice without anchor text
- The blockquote contains extra spaces after the
>
symbolApply these changes:
- [](https://github.com/sponsors/cloudposse) + [![Sponsor us](https://img.shields.io/badge/sponsor-30363D?style=for-the-badge&logo=GitHub-Sponsors&logoColor=#white)](https://github.com/sponsors/cloudposse) - > [](https://github.com/sponsors/cloudposse)This change:
- Removes the duplicate link
- Adds a visually appealing sponsor button
- Fixes the blockquote formatting
Also applies to: 29-29
🧹 Nitpick comments (4)
cmd/markdown/about.md (2)
14-14
: Standardize compound word usage.For consistency in technical documentation, "multi-environment" should be written as "multienvironment".
Apply this change:
-**Scalable**: Designed for multi-account, multi-environment AWS setups. +**Scalable**: Designed for multi-account, multienvironment AWS setups.🧰 Tools
🪛 LanguageTool
[misspelling] ~14-~14: This word is normally spelled as one.
Context: ...Scalable**: Designed for multi-account, multi-environment AWS setups. ## Why Atmos? Atmos reduce...(EN_COMPOUNDS_MULTI_ENVIRONMENT)
17-18
: Improve sentence formatting.The sentence is split across lines which might affect rendering. Consider combining them into a single line for better maintainability.
Apply this change:
-Atmos reduces complexity, promotes consistency, and accelerates delivery, making it an ideal choice -for organizations managing large-scale AWS infrastructure. +Atmos reduces complexity, promotes consistency, and accelerates delivery, making it an ideal choice for organizations managing large-scale AWS infrastructure.cmd/markdown/support.md (2)
8-8
: Add missing GitHub Discussions link.The GitHub Discussions reference should include a clickable link to enhance accessibility.
- **GitHub Discussions**: Post questions or join conversations with the community and Cloud Posse. + **GitHub Discussions**: Post questions or join conversations in our [GitHub Discussions](https://github.com/cloudposse/atmos/discussions).
13-13
: Enhance office hours information.Consider the following improvements:
- Specify whether PST refers to Pacific Standard Time or Pacific Daylight Time (PDT)
- Add a link to join the office hours session
- We hold **office hours every Wednesday at 11:30 AM PST**. Join us for live Q&A, pairing sessions, or help with debugging issues. + We hold **office hours every Wednesday at 11:30 AM Pacific Time**. [Join us](https://cloudposse.com/office-hours) for live Q&A, pairing sessions, or help with debugging issues.
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
cmd/markdown/about.md
(1 hunks)cmd/markdown/support.md
(1 hunks)
🧰 Additional context used
🪛 LanguageTool
cmd/markdown/about.md
[misspelling] ~14-~14: This word is normally spelled as one.
Context: ...Scalable**: Designed for multi-account, multi-environment AWS setups. ## Why Atmos? Atmos reduce...
(EN_COMPOUNDS_MULTI_ENVIRONMENT)
🪛 Markdownlint (0.37.0)
cmd/markdown/support.md
29-29: null
Multiple spaces after blockquote symbol
(MD027, no-multiple-space-blockquote)
🔇 Additional comments (2)
cmd/markdown/about.md (2)
3-5
: Consider enhancing the introduction with more detailed description.The current description is concise but could be more informative about Atmos's capabilities.
Apply this improvement as previously suggested:
-It simplifies the deployment of infrastructure by providing a consistent, YAML-driven configuration system using tools like Terraform and Helmfile. Atmos helps teams adopt best practices, enforce standards, and automate complex workflows across environments. +It simplifies the deployment of infrastructure by providing a consistent, YAML-driven configuration system using tools like Terraform and Helmfile. Atmos helps teams adopt best practices, enforce standards, and automate complex workflows across environments. It simplifies the deployment of infrastructure by providing a consistent, YAML-driven configuration system using tools like Terraform and Helmfile. Atmos helps teams adopt best practices, enforce standards, and automate complex workflows across environments.
20-20
: Improve link formatting to prevent URL duplication.The current markdown format will show the URL twice when rendered.
Apply this improvement as previously suggested:
-Learn more [here](https://atmos.tools) +Learn more [here](https://atmos.tools)
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.
Update tests/test_cases.yml
Does glamour not support justifying all the content to the right of the bullet points when line wrapping? |
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: 2
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
cmd/markdown/support.md
(1 hunks)
🧰 Additional context used
🪛 Markdownlint (0.37.0)
cmd/markdown/support.md
29-29: null
Multiple spaces after blockquote symbol
(MD027, no-multiple-space-blockquote)
🔇 Additional comments (2)
cmd/markdown/support.md (2)
13-14
: Update office hours information with link.Apply these changes as previously suggested:
-We hold **office hours every Wednesday at 11:30 AM PST**. Join us for live Q&A, pairing sessions, or help with debugging issues. +We hold **office hours every Wednesday at 11:30 AM PST**. Join us for live Q&A sessions. + +[](https://cloudposse.com/office-hours)
1-29
: Strong content structure, warrior! 💪The document is well-organized with clear sections for community resources, office hours, and paid support. The hierarchy and flow of information make it easy for users to find the help they need.
🧰 Tools
🪛 Markdownlint (0.37.0)
29-29: null
Multiple spaces after blockquote symbol(MD027, no-multiple-space-blockquote)
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)
cmd/markdown/support.md (2)
5-9
: 🛠️ Refactor suggestionEnhance community resource links for better clarity and completeness.
- Remove the redundant Slack introduction since it's covered in the bullet points.
- Add the missing GitHub Discussions link.
Apply these changes:
-Need help? Join the [Atmos community!](https://cloudposse.com/slack) - - **Slack Community**: Connect with active users in the `#atmos` channel and get help anytime [on slack](https://cloudposse.com/slack). - **GitHub Discussions**: Post questions or join conversations with the community and Cloud Posse. - **Issue Tracker**: Found a bug? Report it [here](https://github.com/cloudposse/atmos/issues). +## Community Resources + +- **Slack Community**: Connect with active users in the `#atmos` channel and get help anytime [on slack](https://cloudposse.com/slack). +- **GitHub Discussions**: Post questions or join conversations in our [GitHub Discussions](https://github.com/cloudposse/atmos/discussions). +- **Issue Tracker**: Found a bug? Report it [here](https://github.com/cloudposse/atmos/issues).
29-30
: 🛠️ Refactor suggestionFix blockquote formatting and remove duplicate link.
The blockquote contains extra spaces and a redundant sponsor link.
Apply this change:
-> **Note**: Paid support includes priority responses. -> [](https://github.com/sponsors/cloudposse) +> **Note**: Paid support includes priority responses.🧰 Tools
🪛 Markdownlint (0.37.0)
30-30: null
Multiple spaces after blockquote symbol(MD027, no-multiple-space-blockquote)
🧹 Nitpick comments (2)
cmd/markdown/about.md (2)
14-14
: STAND STRONG! Let's fix this compound word, warrior!For consistency with technical terminology, "multi-environment" should be written as "multienvironment".
-**Scalable**: Designed for multi-account, multi-environment AWS setups. +**Scalable**: Designed for multi-account, multienvironment AWS setups.🧰 Tools
🪛 LanguageTool
[misspelling] ~14-~14: This word is normally spelled as one.
Context: ...Scalable**: Designed for multi-account, multi-environment AWS setups. ## Why Atmos? Atmos reduce...(EN_COMPOUNDS_MULTI_ENVIRONMENT)
17-18
: UNITE THESE LINES AS ONE, FELLOW WARRIOR!Let's combine these lines for a more powerful presentation.
-Atmos reduces complexity, promotes consistency, and accelerates delivery, making it an ideal choice -for organizations managing large-scale AWS infrastructure. +Atmos reduces complexity, promotes consistency, and accelerates delivery, making it an ideal choice for organizations managing large-scale AWS infrastructure.
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
cmd/markdown/about.md
(1 hunks)cmd/markdown/support.md
(1 hunks)
🧰 Additional context used
🪛 LanguageTool
cmd/markdown/about.md
[misspelling] ~14-~14: This word is normally spelled as one.
Context: ...Scalable**: Designed for multi-account, multi-environment AWS setups. ## Why Atmos? Atmos reduce...
(EN_COMPOUNDS_MULTI_ENVIRONMENT)
🪛 Markdownlint (0.37.0)
cmd/markdown/support.md
30-30: null
Multiple spaces after blockquote symbol
(MD027, no-multiple-space-blockquote)
⏰ Context from checks skipped due to timeout of 90000ms (3)
- GitHub Check: Build (windows-latest, windows)
- GitHub Check: Analyze (go)
- GitHub Check: Summary
🔇 Additional comments (3)
cmd/markdown/about.md (2)
1-5
: WARRIOR! Let us strengthen this introduction!The previous suggestions provide a more precise and powerful description of Atmos. Let's incorporate them to make this introduction worthy of Sparta!
# About Atmos -Atmos is an open-source framework for managing the configuration of Infrastructure as Code (IaC) at scale using Stacks. +Atmos is an open-source framework for managing Infrastructure as Code (IaC) at scale using Stacks. -It simplifies the deployment of infrastructure by providing a consistent, YAML-driven configuration system using tools like Terraform and Helmfile. Atmos helps teams adopt best practices, enforce standards, and automate complex workflows across environments. +It simplifies the deployment of infrastructure by providing a consistent, YAML-driven configuration system using tools like Terraform and Helmfile. Atmos helps teams adopt best practices, enforce standards, and automate complex workflows across environments.
20-20
: STRENGTHEN THIS LINK WITH CLARITY, WARRIOR!Let's improve the link format as previously suggested.
-Learn more [here](https://atmos.tools) +Learn more [here](https://atmos.tools)cmd/markdown/support.md (1)
13-15
: Improve office hours link presentation.The empty link syntax creates unnecessary whitespace. Let's integrate it with the text for better readability.
Apply this change:
-We hold **office hours every Wednesday at 11:30 AM PST**. Join us for live Q&A sessions. - -[](https://cloudposse.com/office-hours) +We hold **office hours every Wednesday at 11:30 AM PST**. [Join us for live Q&A sessions](https://cloudposse.com/office-hours).
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 (3)
cmd/markdown/about.md (2)
7-14
: Fix compound word and enhance feature descriptionsThe key features section is well-structured, but let's make a few improvements:
- **Scalable**: Designed for multi-account, multi-environment AWS setups. + **Scalable**: Designed for multi-account, multienvironment AWS setups.Consider adding brief examples or use cases to each feature point to make them more tangible for users.
🧰 Tools
🪛 LanguageTool
[misspelling] ~14-~14: This word is normally spelled as one.
Context: ...Scalable**: Designed for multi-account, multi-environment AWS setups. ## Why Atmos? Atmos reduce...(EN_COMPOUNDS_MULTI_ENVIRONMENT)
16-18
: Enhance readability of the Why sectionThe content would be more impactful as a single line:
- Atmos reduces complexity, promotes consistency, and accelerates delivery, making it an ideal choice - for organizations managing large-scale AWS infrastructure. + Atmos reduces complexity, promotes consistency, and accelerates delivery, making it an ideal choice for organizations managing large-scale AWS infrastructure.cmd/markdown/support.md (1)
13-15
: Stand strong with your link formatting, warrior!For consistency with other sections, adjust the office hours link format.
We hold **office hours every Wednesday at 11:30 AM PST**. Join us for live Q&A sessions. -[](https://cloudposse.com/office-hours) +[🔗](https://cloudposse.com/office-hours)
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (4)
cmd/about.go
(1 hunks)cmd/markdown/about.md
(1 hunks)cmd/markdown/support.md
(1 hunks)cmd/support.go
(1 hunks)
🚧 Files skipped from review as they are similar to previous changes (2)
- cmd/about.go
- cmd/support.go
🧰 Additional context used
🪛 LanguageTool
cmd/markdown/about.md
[misspelling] ~14-~14: This word is normally spelled as one.
Context: ...Scalable**: Designed for multi-account, multi-environment AWS setups. ## Why Atmos? Atmos reduce...
(EN_COMPOUNDS_MULTI_ENVIRONMENT)
🪛 Markdownlint (0.37.0)
cmd/markdown/support.md
31-31: null
Multiple spaces after blockquote symbol
(MD027, no-multiple-space-blockquote)
⏰ Context from checks skipped due to timeout of 90000ms (2)
- GitHub Check: Build (windows-latest, windows)
- GitHub Check: Summary
🔇 Additional comments (4)
cmd/markdown/about.md (2)
1-5
: Strong introduction that clearly defines Atmos!The introduction effectively communicates Atmos's purpose and value proposition. Well structured with a clear definition followed by its benefits.
20-20
: Clean and effective call-to-action!The link format is clear and follows markdown best practices.
cmd/markdown/support.md (2)
5-9
: 🛠️ Refactor suggestionStrengthen your community resources section, warrior!
- Remove the redundant Slack introduction as it's already covered in the bullet points.
- Add the missing GitHub Discussions URL to guide your fellow warriors.
-Need help? Join the [Atmos community!](https://cloudposse.com/slack) - - **Slack Community**: Connect with active users in the `#atmos` channel and get help anytime [on slack](https://cloudposse.com/slack). - **GitHub Discussions**: Post questions or join conversations with the community and Cloud Posse. - **Issue Tracker**: Found a bug? Report it [here](https://github.com/cloudposse/atmos/issues). +- **Slack Community**: Connect with active users in the `#atmos` channel and get help anytime [on slack](https://cloudposse.com/slack). +- **GitHub Discussions**: Post questions or join conversations in our [GitHub Discussions](https://github.com/cloudposse/atmos/discussions). +- **Issue Tracker**: Found a bug? Report it [here](https://github.com/cloudposse/atmos/issues).Likely invalid or redundant comment.
21-31
: 🛠️ Refactor suggestionSharpen your markdown formatting, brave warrior!
- Remove the duplicate sponsor link to maintain a clean battle formation.
- Fix the blockquote spacing for a more disciplined appearance.
-[](https://github.com/sponsors/cloudposse) +[🔗](https://github.com/sponsors/cloudposse) Included with sponsorship, we host **30-minute workshops twice a week** to: - Answer your questions. - Assist with debugging issues. - Discuss architectural decisions. Workshops are tailored to help you succeed with Atmos, our AWS Reference Architectures, and related tools. -> **Note**: Paid support includes priority responses. -> [](https://github.com/sponsors/cloudposse) +> **Note**: Paid support includes priority responses.Likely invalid or redundant comment.
🧰 Tools
🪛 Markdownlint (0.37.0)
31-31: null
Multiple spaces after blockquote symbol(MD027, no-multiple-space-blockquote)
Co-authored-by: Erik Osterman (CEO @ Cloud Posse) <[email protected]>
Co-authored-by: Erik Osterman (CEO @ Cloud Posse) <[email protected]>
Co-authored-by: Erik Osterman (CEO @ Cloud Posse) <[email protected]>
Co-authored-by: Erik Osterman (CEO @ Cloud Posse) <[email protected]>
Co-authored-by: Erik Osterman (CEO @ Cloud Posse) <[email protected]>
Co-authored-by: Erik Osterman (CEO @ Cloud Posse) <[email protected]>
Co-authored-by: Erik Osterman (CEO @ Cloud Posse) <[email protected]>
Co-authored-by: Erik Osterman (CEO @ Cloud Posse) <[email protected]>
Co-authored-by: Erik Osterman (CEO @ Cloud Posse) <[email protected]>
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 (3)
cmd/markdown/about.md (2)
14-14
: Maintain consistent compound word usage.For consistency with "multi-account", consider using "multienvironment" as a single word.
-**Scalable**: Designed for multi-account, multi-environment AWS setups. +**Scalable**: Designed for multi-account, multienvironment AWS setups.🧰 Tools
🪛 LanguageTool
[misspelling] ~14-~14: This word is normally spelled as one.
Context: ...Scalable**: Designed for multi-account, multi-environment AWS setups. ## Why Atmos? Atmos reduce...(EN_COMPOUNDS_MULTI_ENVIRONMENT)
17-18
: Consolidate lines for better readability.Consider combining these lines into a single line for better flow.
-Atmos reduces complexity, promotes consistency, and accelerates delivery, making it an ideal choice -for organizations managing large-scale AWS infrastructure. +Atmos reduces complexity, promotes consistency, and accelerates delivery, making it an ideal choice for organizations managing large-scale AWS infrastructure.cmd/markdown/support.md (1)
15-15
: Enhance link visibility.The empty markdown link could be improved with a link icon for better visibility.
Apply this diff:
-[](https://cloudposse.com/office-hours) +[🔗](https://cloudposse.com/office-hours)
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (4)
cmd/about.go
(1 hunks)cmd/markdown/about.md
(1 hunks)cmd/markdown/support.md
(1 hunks)cmd/support.go
(1 hunks)
🚧 Files skipped from review as they are similar to previous changes (2)
- cmd/support.go
- cmd/about.go
🧰 Additional context used
🪛 LanguageTool
cmd/markdown/about.md
[misspelling] ~14-~14: This word is normally spelled as one.
Context: ...Scalable**: Designed for multi-account, multi-environment AWS setups. ## Why Atmos? Atmos reduce...
(EN_COMPOUNDS_MULTI_ENVIRONMENT)
🪛 Markdownlint (0.37.0)
cmd/markdown/support.md
31-31: null
Multiple spaces after blockquote symbol
(MD027, no-multiple-space-blockquote)
⏰ Context from checks skipped due to timeout of 90000ms (2)
- GitHub Check: Acceptance Tests (windows-latest, windows)
- GitHub Check: Summary
🔇 Additional comments (4)
cmd/markdown/about.md (2)
1-5
: Consider using the previously approved wording for better clarity.The introduction could be enhanced using the previously suggested wording.
# About Atmos -Atmos is an open-source framework for managing the configuration of Infrastructure as Code (IaC) at scale using Stacks. -It simplifies the deployment of infrastructure by providing a consistent, YAML-driven configuration system using tools like Terraform and Helmfile. Atmos helps teams adopt best practices, enforce standards, and automate complex workflows across environments. +Atmos is an open-source framework for managing Infrastructure as Code (IaC) at scale using Stacks. + +It simplifies the deployment of infrastructure by providing a consistent, YAML-driven configuration system using tools like Terraform and Helmfile. Atmos helps teams adopt best practices, enforce standards, and automate complex workflows across environments.
20-20
: Use the previously approved link format.Consider using the clearer link format as suggested in previous reviews.
-Learn more [here](https://atmos.tools) +Learn more [here](https://atmos.tools)cmd/markdown/support.md (2)
5-9
: 🛠️ Refactor suggestionStreamline community resources section.
- Remove the redundant Slack community introduction since it's covered in the bullet points.
- Add the missing GitHub Discussions URL.
Apply this diff:
-Need help? Join the [Atmos community!](https://cloudposse.com/slack) - - **Slack Community**: Connect with active users in the `#atmos` channel and get help anytime [on slack](https://cloudposse.com/slack). - **GitHub Discussions**: Post questions or join conversations with the community and Cloud Posse. + **Slack Community**: Connect with active users in the `#atmos` channel and get help anytime [on slack](https://cloudposse.com/slack). + **GitHub Discussions**: Post questions or join conversations in our [GitHub Discussions](https://github.com/cloudposse/atmos/discussions).Likely invalid or redundant comment.
21-31
: 🛠️ Refactor suggestionClean up paid support section.
- Remove duplicate sponsor links.
- Fix blockquote formatting.
Apply this diff:
-[](https://github.com/sponsors/cloudposse) - Included with sponsorship, we host **30-minute workshops twice a week** to: - Answer your questions. - Assist with debugging issues. - Discuss architectural decisions. Workshops are tailored to help you succeed with Atmos, our AWS Reference Architectures, and related tools. -> **Note**: Paid support includes priority responses. -> [](https://github.com/sponsors/cloudposse) +> **Note**: Paid support includes priority responses. [🔗](https://github.com/sponsors/cloudposse)Likely invalid or redundant comment.
🧰 Tools
🪛 Markdownlint (0.37.0)
31-31: null
Multiple spaces after blockquote symbol(MD027, no-multiple-space-blockquote)
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.
thanks @Cerebrovinny
These changes were released in v1.138.0. |
what
About and Support command implementation using Glamour and markdown feature
why
It does provide the defined message to help users found info about and support
Support
About
references
Summary by CodeRabbit
New Features
about
command to display information about the Atmos framework.support
command to provide community and support resources.Documentation