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

refactor: scope docs to operating system #27

Merged
merged 1 commit into from
Oct 17, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions docs/architecture.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,13 @@
# Architecture

> This page is specific to Finch running on macOS. At this time macOS is the
> only supported operating system.
!!! Note
This page is specific to Finch running on macOS. At this time macOS is the
only supported operating system.

In this section we will dive into the various open source components that Finch
distributes and how they piece together to form a local development environment.

## Finch Architecture
## Finch macOS Architecture

![Finch Architecture](/assets/finch_architecture.png "Finch Architecture")

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
# Installing Finch
# Installing Finch on macOS

> This page is specific to Finch running on macOS. At this time macOS is the
> only supported operating system.
!!! Note
This page is specific to Finch running on macOS. At this time macOS is the
only supported operating system.

## Prerequisites

Expand All @@ -11,8 +12,8 @@ following prerequisites.
* macOS versions:
* 13 Ventura
* 12 Monterey
* 11 Big Sur
* Both Intel and Apple Silicon based systems are supported.
* 11 Big Sur (known to work, but not tested)
* Both Intel and Apple Silicon based systems running the last 2 major versions of macOS are supported.
* Recommended minimum hardware requirements is at least 2 vCPU and 4 GB memory.
* Administrative privileges are required to install Finch on to the machine.

Expand All @@ -22,15 +23,15 @@ To install Finch with a package manager you can leverage the
[homebrew](https://brew.sh/) package manager.

1. Verify that homebrew is already installed on the system by running the brew
help command `brew help`. If it is not, navigate to the homebrew
documentation for [installation
help command `brew help` in your favorite terminal application. If it is not,
navigate to the homebrew documentation for [installation
instructions](https://docs.brew.sh/Installation).

```bash
brew help
```

2. Install Finch using the `brew` cli. If prompted, enter your macOS password.
2. Install Finch using the `brew` CLI. If prompted, enter your macOS password.

```bash
brew install finch
Expand All @@ -53,31 +54,30 @@ Releases](https://github.com/runfinch/finch/releases) page. Ensuring you have
[Finder](https://support.apple.com/en-us/HT201732), you can double click the
`.pkg` and start the installation. Click continue.

![Finch Installation Wizard](/assets/finch_installation_1.png "Finch Installation 1")
![Finch Installation Wizard](/assets/finch_macos_installation_1.png "Finch Installation 1")

3. Read and accept the Finch license and click continue.

![Finch Installation License](/assets/finch_installation_2.png "Finch Installation 2")
![Finch Installation License](/assets/finch_macos_installation_2.png "Finch Installation 2")

4. Click Install. This will prompt you for your macOS password.

![Finch Installation Screen](/assets/finch_installation_3.png "Finch Installation 3")
![Finch Installation Screen](/assets/finch_macos_installation_3.png "Finch Installation 3")

5. When the Finch installation is complete, you can close the installation
prompt. You can now [verify the
installation](#verify-the-finch-installation).

![Finch Installation Complete](/assets/finch_installation_4.png "Finch Installation 4")
![Finch Installation Complete](/assets/finch_macos_installation_4.png "Finch Installation 4")

## Verify the Finch Installation

Now that Finch has been successfully installed, you can verify the installation
with the following steps.

1. Once the installation is complete, `finch vm init` is required once to set up
the underlying system and create the virtual machines. This initial setup
usually takes about a minute or two, and may once again require your macOS
password.
1. Once the installation is complete, running the `finch vm init` command once is required
to set up the underlying system and create the virtual machine. This initial setup
usually takes about a minute, and may once again require your macOS password.

```bash
finch vm init
Expand Down Expand Up @@ -120,7 +120,7 @@ with the following steps.

## Next Steps

In this short guide you learned how to install Finch on to your workstation and
In this short guide you learned how to install Finch on to your macOS workstation and
start the virtual machine.

* To learn how to run your first containerized application see [Running
Expand Down
5 changes: 3 additions & 2 deletions docs/docs/managing-finch/uninstalling-finch.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
# Uninstalling Finch

> This page is specific to Finch running on macOS. At this time macOS is the
> only supported operating system.
!!! Note
This page is specific to Finch running on macOS. At this time macOS is the
only supported operating system.

Depending on the installation method, the process to uninstall Finch varies. If
you are leveraging the [homebrew](https://brew.sh/) package manager, you can use
Expand Down
7 changes: 4 additions & 3 deletions docs/docs/managing-finch/upgrading-finch.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
# Upgrading Finch

> This page is specific to Finch running on macOS. At this time macOS is the
> only supported operating system.
!!! Note
This page is specific to Finch running on macOS. At this time macOS is the
only supported operating system.

Finch releases updates on a regular cadence, to find the latest release and the
subsequent release notes, see the [Release Notes](../changelog.md).
Expand Down Expand Up @@ -89,7 +90,7 @@ Releases](https://github.com/runfinch/finch/releases) page. Ensuring you have
warning that an existing version of Finch has been found and that it will be
removed prior to upgrade. Click Ok on the pop up, and continue on the wizard.

![Finch Upgrade Wizard](/assets/finch_upgrade_1.png "Finch Upgrade 1")
![Finch Upgrade Wizard](/assets/finch_macos_upgrade_1.png "Finch Upgrade 1")

3. Click through the various pages in the wizard. This
wizard is the same as wizard previously seen during the
Expand Down
4 changes: 3 additions & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ nav:
- Docs:
- "docs/index.md"
- Getting Started:
- Installing Finch: "docs/getting-started/installing.md"
- Installing Finch: "docs/getting-started/installing/installing_macos.md"
- Building Images: "docs/getting-started/building-images.md"
- Running Containers: "docs/getting-started/running-containers.md"
- Pushing Images: "docs/getting-started/pushing-images.md"
Expand Down Expand Up @@ -62,6 +62,8 @@ copyright: Copyright © Amazon 2023
markdown_extensions:
- pymdownx.highlight
- pymdownx.superfences
- admonition
- pymdownx.details
- pymdownx.tabbed:
alternate_style: true
plugins:
Expand Down