diff --git a/docs/architecture.md b/docs/architecture.md index ab0484c4..7b90b083 100644 --- a/docs/architecture.md +++ b/docs/architecture.md @@ -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") diff --git a/docs/assets/finch_architecture.png b/docs/assets/finch_macos_architecture.png similarity index 100% rename from docs/assets/finch_architecture.png rename to docs/assets/finch_macos_architecture.png diff --git a/docs/assets/finch_installation_1.png b/docs/assets/finch_macos_installation_1.png similarity index 100% rename from docs/assets/finch_installation_1.png rename to docs/assets/finch_macos_installation_1.png diff --git a/docs/assets/finch_installation_2.png b/docs/assets/finch_macos_installation_2.png similarity index 100% rename from docs/assets/finch_installation_2.png rename to docs/assets/finch_macos_installation_2.png diff --git a/docs/assets/finch_installation_3.png b/docs/assets/finch_macos_installation_3.png similarity index 100% rename from docs/assets/finch_installation_3.png rename to docs/assets/finch_macos_installation_3.png diff --git a/docs/assets/finch_installation_4.png b/docs/assets/finch_macos_installation_4.png similarity index 100% rename from docs/assets/finch_installation_4.png rename to docs/assets/finch_macos_installation_4.png diff --git a/docs/assets/finch_upgrade_1.png b/docs/assets/finch_macos_upgrade_1.png similarity index 100% rename from docs/assets/finch_upgrade_1.png rename to docs/assets/finch_macos_upgrade_1.png diff --git a/docs/docs/getting-started/installing.md b/docs/docs/getting-started/installing/installing_macos.md similarity index 76% rename from docs/docs/getting-started/installing.md rename to docs/docs/getting-started/installing/installing_macos.md index 6d53b052..2fce777a 100644 --- a/docs/docs/getting-started/installing.md +++ b/docs/docs/getting-started/installing/installing_macos.md @@ -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 @@ -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. @@ -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 @@ -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 @@ -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 diff --git a/docs/docs/managing-finch/uninstalling-finch.md b/docs/docs/managing-finch/uninstalling-finch.md index e07f5f6c..21f5f4ff 100644 --- a/docs/docs/managing-finch/uninstalling-finch.md +++ b/docs/docs/managing-finch/uninstalling-finch.md @@ -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 diff --git a/docs/docs/managing-finch/upgrading-finch.md b/docs/docs/managing-finch/upgrading-finch.md index 30fec325..b2b25e8d 100644 --- a/docs/docs/managing-finch/upgrading-finch.md +++ b/docs/docs/managing-finch/upgrading-finch.md @@ -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). @@ -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 diff --git a/mkdocs.yml b/mkdocs.yml index ad993e51..e656b4e2 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -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" @@ -62,6 +62,8 @@ copyright: Copyright © Amazon 2023 markdown_extensions: - pymdownx.highlight - pymdownx.superfences + - admonition + - pymdownx.details - pymdownx.tabbed: alternate_style: true plugins: