-
-
Notifications
You must be signed in to change notification settings - Fork 125
<
8000
div
class="position-relative js-review-state-classes js-suggested-changes-files-tab"
data-pjax
data-discussion-hovercards-enabled
data-issue-and-pr-hovercards-enabled
>
Show file tree
Hide file tree
Jan 4, 2025
Jan 4, 2025
Jan 4, 2025
Jan 4, 2025
Jan 4, 2025
Jan 4, 2025
Jan 5, 2025
Jan 6, 2025
Jan 6, 2025
Jan 6, 2025
Jan 6, 2025
Jan 6, 2025
Jan 6, 2025
Jan 6, 2025
Jan 7, 2025
Loading
Support and About command implementation #909
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
Merged
Changes from all commits
Commits
Show all changes
15 commits
Select commit
Hold shift + click to select a range
452b0e0
about command
Cerebrovinny ea6378d
support markdown implementation
Cerebrovinny 1aba49d
Update cmd/markdown/about.md
Cerebrovinny dad75dd
Update cmd/markdown/support.md
Cerebrovinny b0a5921
Update cmd/markdown/support.md
Cerebrovinny def5d7c
Update cmd/markdown/about.md
Cerebrovinny 58661eb
Update cmd/markdown/support.md
Cerebrovinny 076a6f8
Update cmd/markdown/about.md
Cerebrovinny 010753a
Update cmd/markdown/support.md
Cerebrovinny 9d24dd0
Update cmd/markdown/support.md
Cerebrovinny a94ca6d
Update cmd/markdown/support.md
Cerebrovinny a9dc677
Update cmd/markdown/support.md
osterman 099eb04
Update cmd/markdown/support.md
osterman b5b8936
fix command error
Cerebrovinny 5c3c277
Apply suggestions from code review
osterman File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,45 @@ | ||
package cmd | ||
|
||
import ( | ||
_ "embed" | ||
"fmt" | ||
"os" | ||
|
||
"github.com/charmbracelet/glamour" | ||
"github.com/spf13/cobra" | ||
) | ||
|
||
//go:embed markdown/about.md | ||
var aboutMarkdown string | ||
|
||
// aboutCmd represents the about command | ||
var aboutCmd = &cobra.Command{ | ||
Use: "about", | ||
Short: "Learn about Atmos", | ||
Long: `Display information about Atmos, its features, and benefits.`, | ||
Args: cobra.NoArgs, | ||
DisableSuggestions: true, | ||
SilenceUsage: true, | ||
SilenceErrors: true, | ||
RunE: func(cmd *cobra.Command, args []string) error { | ||
renderer, err := glamour.NewTermRenderer( | ||
glamour.WithAutoStyle(), | ||
glamour.WithWordWrap(80), | ||
) | ||
if err != nil { | ||
return fmt.Errorf("failed to create markdown renderer: %w", err) | ||
} | ||
|
||
out, err := renderer.Render(aboutMarkdown) | ||
if err != nil { | ||
return fmt.Errorf("failed to render about documentation: %w", err) | ||
} | ||
|
||
fmt.Fprint(os.Stdout, out) | ||
return nil | ||
}, | ||
} | ||
|
||
func init() { | ||
RootCmd.AddCommand(aboutCmd) | ||
} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
# 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. | ||
|
||
## Key Features | ||
|
||
- **Reusable Components**: Modular building blocks for defining infrastructure. | ||
- **Stacks**: Environment-specific configurations for managing multiple AWS accounts. | ||
- **YAML-Based**: Declarative configurations for easy maintenance. | ||
- **Terraform & Helmfile**: Unified commands for seamless integration. | ||
- **Automation-Ready**: Perfect for CI/CD pipelines and DevOps workflows. | ||
- **Scalable**: Designed for multi-account, multi-environment AWS setups. | ||
|
||
## Why Atmos? | ||
Atmos reduces complexity, promotes consistency, and accelerates delivery, making it an ideal choice | ||
for organizations managing large-scale AWS infrastructure. | ||
|
||
Learn more [here](https://atmos.tools) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,31 @@ | ||
# Support | ||
|
||
## Community Resources | ||
|
||
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). | ||
|
||
## 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) | ||
|
||
## Paid Support | ||
|
||
We offer priority support to GitHub Sponsors (Enterprise Tier). | ||
|
||
[](https://github.com/sponsors/cloudposse) | ||
Cerebrovinny marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
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) | ||
Cerebrovinny marked this conversation as resolved.
Show resolved
Hide resolved
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,45 @@ | ||
package cmd | ||
|
||
import ( | ||
_ "embed" | ||
"fmt" | ||
"os" | ||
|
||
"github.com/charmbracelet/glamour" | ||
"github.com/spf13/cobra" | ||
) | ||
|
||
//go:embed markdown/support.md | ||
var supportMarkdown string | ||
|
||
// supportCmd represents the support command | ||
var supportCmd = &cobra.Command{ | ||
Use: "support", | ||
Short: "Show Atmos support options", | ||
Long: `Display information about Atmos support options, including community resources and paid support.`, | ||
Args: cobra.NoArgs, | ||
DisableSuggestions: true, | ||
SilenceUsage: true, | ||
SilenceErrors: true, | ||
RunE: func(cmd *cobra.Command, args []string) error { | ||
renderer, err := glamour.NewTermRenderer( | ||
glamour.WithAutoStyle(), | ||
glamour.WithWordWrap(80), | ||
) | ||
if err != nil { | ||
return fmt.Errorf("failed to create markdown renderer: %w", err) | ||
} | ||
|
||
out, err := renderer.Render(supportMarkdown) | ||
if err != nil { | ||
return fmt.Errorf("failed to render support documentation: %w", err) | ||
} | ||
|
||
fmt.Fprint(os.Stdout, out) | ||
return nil | ||
}, | ||
} | ||
|
||
func init() { | ||
RootCmd.AddCommand(supportCmd) | ||
} |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while
2E9F
viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.