Skip to content

Commit

Permalink
update installation instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
osterman committed Jun 17, 2024
1 parent 417d3cd commit 065b7fa
Show file tree
Hide file tree
Showing 10 changed files with 36 additions and 18 deletions.
13 changes: 12 additions & 1 deletion website/docs/quick-start/install-atmos.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ import TabItem from '@theme/TabItem';
import Link from '@docusaurus/Link';
import Intro from '@site/src/components/Intro'
import LatestRelease from '@site/src/components/LatestRelease'
import File from '@site/src/components/File'

<Intro>
There are many ways to install Atmos. Choose the method that works best for you!
Expand All @@ -32,6 +33,16 @@ Atmos has native packages for macOS and every major Linux distribution. We also
```shell
brew install atmos
```

#### Pro tip! Use a `Brewfile`

Create a `Brewfile` in your Atmos project, and add `brew "atmos"`. This way, you can ensure that everyone on your team is using the same version of Atmos.

<File title="Brewfile">
<pre><code>brew "atmos", "<LatestRelease />"</code></pre>
</File>

Then just run `brew install` in the same directory as the `Brewfile`.
</TabItem>

<TabItem value="deb" label="Debian/Ubuntu">
Expand Down Expand Up @@ -141,7 +152,7 @@ Atmos has native packages for macOS and every major Linux distribution. We also
</Tabs>

:::note
The latest version of Atmos might not be available with third party package managers.
The latest version of Atmos (<LatestRelease />) might not be available with third party package managers.
:::


Expand Down
2 changes: 1 addition & 1 deletion website/docs/quick-start/simple/configure-cli.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Configure Atmos CLI
sidebar_position: 2
sidebar_label: Configure Atmos CLI
sidebar_label: 2. Configure Atmos CLI
---
import EmbedFile from '@site/src/components/EmbedFile'
import KeyPoints from '@site/src/components/KeyPoints'
Expand Down
2 changes: 1 addition & 1 deletion website/docs/quick-start/simple/configure-repository.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Start Your Project
sidebar_position: 1
sidebar_label: Start Your Project
sidebar_label: 1. Start Your Project
---
import KeyPoints from '@site/src/components/KeyPoints'
import Intro from '@site/src/components/Intro'
Expand Down
2 changes: 1 addition & 1 deletion website/docs/quick-start/simple/create-atmos-stacks.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Use Your Component in a Stack
sidebar_position: 4
sidebar_label: Configure with Stacks
sidebar_label: 4. Configure with Stacks
---
import File from '@site/src/components/File'
import KeyPoints from '@site/src/components/KeyPoints'
Expand Down
2 changes: 1 addition & 1 deletion website/docs/quick-start/simple/provision.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Deploy Everything
sidebar_position: 5
sidebar_label: Deploy Everything
sidebar_label: 5. Deploy Everything
---
import KeyPoints from '@site/src/components/KeyPoints'
import Intro from '@site/src/components/Intro'
Expand Down
6 changes: 3 additions & 3 deletions website/docs/quick-start/simple/simple.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,7 @@ In this simple example, we’re going to show you how you can Terraform the weat
allowing us to concentrate on the core concepts of Atmos.
</Intro>

You're about discover a new way to think about terraform...

Start your first project in 5 easy steps. After this, you'll be able to configure and provision infrastructure with Terraform using Atmos.
You're about discover [a new way to think about terraform...](/quick-start/mindset)

<KeyPoints>
1. How to set up a project repository to organize your Terraform code and configurations
Expand Down Expand Up @@ -54,4 +52,6 @@ Then, maybe checkout the "Extra Credit" to learn how to...

## What's Included

Start your first project in 5 easy steps. After this, you'll be able to configure and provision infrastructure with Terraform using Atmos.

<DocCardList/>
19 changes: 11 additions & 8 deletions website/docs/quick-start/simple/summary.mdx
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@
---
title: Summary
title: Where to go from here...
sidebar_position: 8
sidebar_label: Summary
sidebar_label: Next Steps
---
import KeyPoints from '@site/src/components/KeyPoints'
import Intro from '@site/src/components/Intro'
import ActionCard from '@site/src/components/ActionCard'
import PrimaryCTA from '@site/src/components/PrimaryCTA'

<Intro>
Atmos provides unlimited flexibility in defining and configuring stacks and components in the stacks.
Expand All @@ -21,16 +23,17 @@ Atmos provides unlimited flexibility in defining and configuring stacks and comp
All the above makes Atmos an ideal framework to organize infrastructure, to design for organizational complexity, and to provision multi-account
environments for very complex organizations.

## Next Steps

You have just learned the **basics of Atmos**.

Atmos is a powerful enterprise-grade workflow automation tool with so **much more to offer**!

## What's next?

Here are some of the major differentiators of Atmos:

1. [Review Atmos Design Patterns](/design-patterns)
2. [Use GitHub Actions](/integrations/github-actions)
3. [Try the Advanced Tutorial](/quick-start/advanced)

<ActionCard title="Next Steps">
Now that you’ve seen Atmos in action, take a moment to explore the core concepts of Atmos.

You have only just scratched the surface Atmos. Atmos is a powerful enterprise-grade framework with so **much more to offer**!
<PrimaryCTA to="/core-concepts">Learn Core Concepts</PrimaryCTA>
</ActionCard>
2 changes: 1 addition & 1 deletion website/docs/quick-start/simple/write-components.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Write Some Components
sidebar_position: 3
sidebar_label: Write Some Components
sidebar_label: 3. Write Some Components
---
import EmbedFile from '@site/src/components/EmbedFile'
import KeyPoints from '@site/src/components/KeyPoints'
Expand Down
2 changes: 1 addition & 1 deletion website/src/components/ActionCard/index.css
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
margin-right: 100%;
}

.action-card div a.button.button--lg.button--primary {
.action-card p > div a.button.button--lg.button--primary {
margin-right: inherit;
}

Expand Down
4 changes: 4 additions & 0 deletions website/src/css/custom.css
Original file line number Diff line number Diff line change
Expand Up @@ -193,6 +193,10 @@ article ul >li, article ol > li {
margin-bottom: 1em;
}

article ul >li::marker, article ol > li::marker {
font-weight: bold;
}

article ul li a:first-child, article ol li a:first-child {
font-weight: bold;
}
Expand Down

0 comments on commit 065b7fa

Please sign in to comment.