rename docs folder to site

This commit is contained in:
Lucy Cifferello
2021-12-20 11:36:52 -07:00
parent 01b8dad941
commit fb5a363096
4 changed files with 49 additions and 70 deletions

2
.gitignore vendored
View File

@@ -2,6 +2,4 @@
.vscode/ .vscode/
build-send.sh build-send.sh
site/_build site/_build
site/_utils/docsearch_config.json
site/_utils/docsearch_index.js
.env .env

View File

@@ -42,10 +42,10 @@ git clone https://github.com/Start9Labs/documentation.git && cd documentation
git submodule update --init git submodule update --init
``` ```
1. Navigate to the `docs` folder and start the project: 1. Navigate to the `site` folder and start the project:
``` ```
cd docs cd site
make clean && make preview make clean && make preview
``` ```
## Development ## Development

6
poetry.lock generated
View File

@@ -126,7 +126,7 @@ python-versions = ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*"
[[package]] [[package]]
name = "importlib-metadata" name = "importlib-metadata"
version = "4.9.0" version = "4.10.0"
description = "Read metadata from Python packages" description = "Read metadata from Python packages"
category = "dev" category = "dev"
optional = false optional = false
@@ -673,8 +673,8 @@ imagesize = [
{file = "imagesize-1.3.0.tar.gz", hash = "sha256:cd1750d452385ca327479d45b64d9c7729ecf0b3969a58148298c77092261f9d"}, {file = "imagesize-1.3.0.tar.gz", hash = "sha256:cd1750d452385ca327479d45b64d9c7729ecf0b3969a58148298c77092261f9d"},
] ]
importlib-metadata = [ importlib-metadata = [
{file = "importlib_metadata-4.9.0-py3-none-any.whl", hash = "sha256:e8b45564028bc25f8c99f546616112a6df5de6655893d7eb74c9a99680dc9751"}, {file = "importlib_metadata-4.10.0-py3-none-any.whl", hash = "sha256:b7cf7d3fef75f1e4c80a96ca660efbd51473d7e8f39b5ab9210febc7809012a4"},
{file = "importlib_metadata-4.9.0.tar.gz", hash = "sha256:ee50794eccb0ec340adbc838344ebb9a6ff2bcba78f752d31fc716497e2149d6"}, {file = "importlib_metadata-4.10.0.tar.gz", hash = "sha256:92a8b58ce734b2a4494878e0ecf7d79ccd7a128b5fc6014c401e0b61f006f0f6"},
] ]
jinja2 = [ jinja2 = [
{file = "Jinja2-3.0.3-py3-none-any.whl", hash = "sha256:077ce6014f7b40d03b47d1f1ca4b0fc8328a692bd284016f806ed0eaca390ad8"}, {file = "Jinja2-3.0.3-py3-none-any.whl", hash = "sha256:077ce6014f7b40d03b47d1f1ca4b0fc8328a692bd284016f806ed0eaca390ad8"},

View File

@@ -5,8 +5,11 @@
<div class="landing landing--floating"> <div class="landing landing--floating">
.. hero-box:: .. hero-box::
:title: Documentation :title: Welcome to the Start9 Documentation
:button_icon: scylla-icon scylla-icon--monitoring :button_icon: scylla-icon scylla-icon--monitoring
:button_url: user-manual
:button_text: Start here
:image: /_static/img/icons/docs_info.png
Here you will find guidance and information about the Start9 Embassy personal server and its operating system, EmbassyOS. Here you will find guidance and information about the Start9 Embassy personal server and its operating system, EmbassyOS.
@@ -21,94 +24,72 @@
<div class="grid-x grid-margin-x"> <div class="grid-x grid-margin-x">
.. topic-box:: .. topic-box::
:title: Getting Started :title: Purchasing
:link: getting-started :link: user-manual/getting-started/purchasing
:icon: scylla-icon scylla-icon--knowledge-base :icon: scylla-icon scylla-icon--bitcoin
:class: large-6 :class: large-6
:anchor: Begin :anchor: Learn more
Dive into the Embassy documentation and other helpful guides Learn about how you can purchase Start9 products.
.. topic-box:: .. topic-box::
:title: User Manual :title: Videos
:link: user-manual :link: https://www.youtube.com/channel/UCGEw4HJDvOn3Oy8ykR36P7Q
:icon: scylla-icon scylla-icon--integrations :icon: scylla-icon scylla-icon--webinars
:class: large-6 :class: large-6
:anchor: View :anchor: Learn more
Get started with learning how to use EmbassyOS Check out our how to and informational videos.
.. topic-box::
:title: Misc Guides
:link: misc-guides
:icon: scylla-icon scylla-icon--docs
:class: large-6
:anchor: View
Setup your devices and Embassy for better connectivity and performance
.. topic-box:: .. topic-box::
:title: Support :title: Support
:link: support :link: knowledge-base/faq
:icon: scylla-icon scylla-icon--support :icon: scylla-icon scylla-icon--support
:class: large-6 :class: large-6
:anchor: Get help :anchor: Learn more
Learn about or troubleshoot your Embassy Read our FAQ and learn about platform concepts.
.. topic-box::
:title: DIY
:link: user-manual/tuning/diy
:icon: scylla-icon scylla-icon--integrations
:class: large-6
:anchor: Learn more
Get started yourself with our Do It Yourself guide
.. topic-box::
:title: About
:link: about
:icon: scylla-icon scylla-icon--about-team
:class: large-6
:anchor: Learn more
Explore Start9's mission and philosophy.
.. topic-box:: .. topic-box::
:title: Contribute :title: Contribute
:link: contributing :link: dev-docs/dev-faq/faq-contributing
:icon: scylla-icon scylla-icon--apps :icon: scylla-icon scylla-icon--apps
:class: large-6 :class: large-6
:anchor: Get started :anchor: Learn more
Use your skills to add to the Start9 ecosystem Learn about developing for EmbassyOS or contribute to packing services for the marketplace.
.. topic-box:: .. raw:: html
:title: FAQ
:link: support/FAQ
:icon: scylla-icon scylla-icon--search
:class: large-6
:anchor: Get answers
Find answers to common questions </div></div>
.. .. topic-box:: .. raw:: html
.. :title: Learn
.. :link: support/FAQ
.. :icon: scylla-icon scylla-icon--webinars
.. :class: large-6
.. :anchor: Get started
.. Read our FAQ and learn about platform concepts
.. .. topic-box::
.. :title: Purchasing
.. :link: https://store.start9.com
.. :icon: scylla-icon scylla-icon--bitcoin
.. :class: large-4
.. :anchor: Buy now
.. Learn about how you can purchase Start9 products
.. .. topic-box::
.. :title: Build your own
.. :link: user-manual/tuning/diy
.. :icon: scylla-icon scylla-icon--integrations
.. :class: large-4
.. :anchor: Get started
.. Build from source with our DIY guide
</div></div>
.. This is for the side navigation display .. This is for the side navigation display
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 2
:hidden: :hidden:
getting-started/index
user-manual/index user-manual/index
misc-guides/index knowledge-base/index
contributing/index dev-docs/index
support/index