From 64ca5b2016522ed1393b16cfcb3f106248f0b7d3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ga=C3=ABtan=20Trellu?= Date: Mon, 11 Sep 2023 21:31:55 -0400 Subject: [PATCH] Add index page --- docs/index.md | 15 +++++++++++++++ mkdocs.yml | 6 +++--- 2 files changed, 18 insertions(+), 3 deletions(-) create mode 100644 docs/index.md diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000..17346c9 --- /dev/null +++ b/docs/index.md @@ -0,0 +1,15 @@ +# Getting started + +Want to give Open Voice OS a try? Open Voice OS is open source software that runs where you want it to, whether it’s on your [own hardware](../about/why-use-ovos.md#multi-device-compatibility) or one of the dedicated [Mark 1](https://mycroft.ai/product/mycroft-mark-1/) or [Mark II](https://mycroft.ai/product/mark-ii/). + +
+ +- :material-docker:{ .xl .middle } __Docker__ + + `arm64` :material-check-circle-outline:{ style="color: green" } `x86_64` :material-check-circle-outline:{ style="color: green" } + + Use container engine such as [Docker](https://www.docker.com/) or [Podman](https://podman.io/) and their `composer` to run a ^^complete^^, ^^secure^^, ^^isolated^^ and ^^"easy to update"^^ instance of Open Voice OS! + + [:octicons-arrow-right-24: Getting started with Docker](./docker/index.md) + +
diff --git a/mkdocs.yml b/mkdocs.yml index eb631e3..f2b4dd5 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,12 +1,12 @@ -site_name: Open Voice OS Docker Documentation +site_name: Open Voice OS Container Documentation site_url: https://openvoiceos.github.io/ovos-docker/ site_author: Gaëtan Trellu site_description: >- - Use Docker or Podman to deploy Open Voice OS components on x86 or ARM64. + Use Docker or Podman to deploy Open Voice OS components on x86 or ARM64 platforms. repo_name: OpenVoiceOS/ovos-docker repo_url: https://github.com/OpenVoiceOS/ovos-docker -edit_uri: edit/main/docs/ +edit_uri: edit/documentation/docs/ copyright: | 2023 Open Voice OS