Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Support and About command implementation #909

Merged
merged 15 commits into from
Jan 7, 2025
Merged

Support and About command implementation #909

merged 15 commits into from
Jan 7, 2025

Conversation

Cerebrovinny
Copy link
Collaborator

@Cerebrovinny Cerebrovinny commented Jan 4, 2025

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
Screenshot 2025-01-04 at 17 42 38

About
Screenshot 2025-01-04 at 17 42 45

references

Summary by CodeRabbit

  • New Features

    • Added about command to display information about the Atmos framework.
    • Added support command to provide community and support resources.
    • Introduced detailed markdown documentation about Atmos capabilities and support options.
  • Documentation

    • Created comprehensive markdown files for the about and support sections.
    • Added community resources, office hours, and paid support information.

@mergify mergify bot added the triage Needs triage label Jan 4, 2025
@Cerebrovinny Cerebrovinny marked this pull request as ready for review January 4, 2025 17:48
@Cerebrovinny Cerebrovinny requested a review from a team as a code owner January 4, 2025 17:48
Copy link
Contributor

coderabbitai bot commented Jan 4, 2025

📝 Walkthrough

Walkthrough

This pull request introduces two new CLI commands, aboutCmd and supportCmd, to the Atmos application. These commands utilize the Cobra library and Glamour markdown renderer to display informative content about the Atmos framework and its support options. The changes involve creating markdown files for "About" and "Support" sections, implementing command logic to render these files, and integrating the new commands into the CLI's root command structure.

Changes

File Change Summary
cmd/about.go Added new aboutCmd with markdown rendering for application information
cmd/markdown/about.md Created markdown file with Atmos framework overview and features
cmd/support.go Added new supportCmd with markdown rendering for support resources
cmd/markdown/support.md Created markdown file detailing community and paid support options

Assessment against linked issues

Objective Addressed Explanation
Implement atmos about command [DEV-2863]
Embed markdown using Go embeds
Render using Glamour
Provide sales pitch for Atmos

Possibly related PRs

Suggested labels

minor

Suggested reviewers

  • aknysh
  • Gowiem

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?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

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)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary or @auto-summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai or @auto-title anywhere in the PR title to generate the title automatically.

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@coderabbitai coderabbitai bot left a 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 if aboutMarkdown 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 empty supportMarkdown.

 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

📥 Commits

Reviewing files that changed from the base of the PR and between 52a3442 and 70f990e.

📒 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 as aboutCmd. This consistency is good for maintainability.

coderabbitai[bot]
coderabbitai bot previously approved these changes Jan 4, 2025
@mergify mergify bot removed the triage Needs triage label Jan 4, 2025
@osterman
Copy link
Member

osterman commented Jan 4, 2025

Is there a way we can prevent markdown links without anchor text from getting duplicated?

cmd/markdown/about.md Outdated Show resolved Hide resolved
cmd/markdown/support.md Outdated Show resolved Hide resolved
cmd/markdown/support.md Outdated Show resolved Hide resolved
cmd/markdown/about.md Outdated Show resolved Hide resolved
coderabbitai[bot]
coderabbitai bot previously approved these changes Jan 4, 2025
coderabbitai[bot]
coderabbitai bot previously approved these changes Jan 4, 2025
@mergify mergify bot removed the triage Needs triage label Jan 4, 2025
@Cerebrovinny
Copy link
Collaborator Author

Thanks @osterman here is the changes you pushed
Screenshot 2025-01-04 at 19 37 32
Screenshot 2025-01-04 at 19 37 27

Copy link
Contributor

@coderabbitai coderabbitai bot left a 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 suggestion

Remove duplicate sponsor links and fix blockquote formatting.

  1. The GitHub sponsors link appears twice without anchor text
  2. The blockquote contains extra spaces after the > symbol

Apply 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:

  1. Specify whether PST refers to Pacific Standard Time or Pacific Daylight Time (PDT)
  2. 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

📥 Commits

Reviewing files that changed from the base of the PR and between 70f990e and e994248.

📒 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)

cmd/markdown/support.md Show resolved Hide resolved
cmd/markdown/support.md Outdated Show resolved Hide resolved
cmd/markdown/support.md Outdated Show resolved Hide resolved
cmd/markdown/about.md Outdated Show resolved Hide resolved
Copy link
Member

@osterman osterman left a 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

@osterman
Copy link
Member

osterman commented Jan 5, 2025

Does glamour not support justifying all the content to the right of the bullet points when line wrapping?

Copy link
Contributor

@coderabbitai coderabbitai bot left a 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

📥 Commits

Reviewing files that changed from the base of the PR and between e994248 and c3a887a.

📒 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)

cmd/markdown/support.md Show resolved Hide resolved
cmd/markdown/support.md Outdated Show resolved Hide resolved
@mergify mergify bot added the triage Needs triage label Jan 5, 2025
Copy link
Contributor

@coderabbitai coderabbitai bot left a 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 suggestion

Enhance community resource links for better clarity and completeness.

  1. Remove the redundant Slack introduction since it's covered in the bullet points.
  2. 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 suggestion

Fix 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

📥 Commits

Reviewing files that changed from the base of the PR and between c3a887a and 347d975.

📒 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).

Copy link
Contributor

@coderabbitai coderabbitai bot left a 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 descriptions

The 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 section

The 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

📥 Commits

Reviewing files that changed from the base of the PR and between 636a343 and 680888d.

📒 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 suggestion

Strengthen your community resources section, warrior!

  1. Remove the redundant Slack introduction as it's already covered in the bullet points.
  2. 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 suggestion

Sharpen your markdown formatting, brave warrior!

  1. Remove the duplicate sponsor link to maintain a clean battle formation.
  2. 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)

Cerebrovinny and others added 14 commits January 7, 2025 16:42
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]>
@mergify mergify bot removed the triage Needs triage label Jan 7, 2025
Copy link
Contributor

@coderabbitai coderabbitai bot left a 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

📥 Commits

Reviewing files that changed from the base of the PR and between 680888d and 5c3c277.

📒 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 suggestion

Streamline community resources section.

  1. Remove the redundant Slack community introduction since it's covered in the bullet points.
  2. 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 suggestion

Clean up paid support section.

  1. Remove duplicate sponsor links.
  2. 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)

@aknysh aknysh added the minor New features that do not break anything label Jan 7, 2025
Copy link
Member

@aknysh aknysh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks @Cerebrovinny

@aknysh aknysh merged commit 2019d88 into main Jan 7, 2025
48 checks passed
@aknysh aknysh deleted the DEV-2863 branch January 7, 2025 18:14
Copy link

github-actions bot commented Jan 7, 2025

These changes were released in v1.138.0.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
minor New features that do not break anything
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants