Merge pull request #559 from trawler/readme_docs_website

Forward users to docs main site for k0s instructions

README.md

@@ -23,18 +23,19 @@ k0s is an all-inclusive Kubernetes distribution with all the required bells and
 - Supports custom Container Network Interface (CNI) plugins (calico is the default)
 - Supports x86_64 and arm64
 
-## Join the Community
-If you'd like to help build k0s, please check out our guide to [Contributing](https://github.com/k0sproject/k0s/tree/main/CONTRIBUTING.md) and our [Code of Conduct](https://github.com/k0sproject/k0s/tree/main/CODE_OF_CONDUCT.md).
+## Try k0s
 
-## Quick start
+If you'd like to try k0s, please jump to our:
 
-```
-curl -sSLf https://get.k0s.sh | sh
-k0s server --enable-worker
-```
+- [Super QuickStart](https://docs.k0sproject.io/main/k0s-single-node/) - Create a k0s control plane and worker, and access it locally with kubectl.
+- [NanoDemo](https://docs.k0sproject.io/main/#demo) - Watch a .gif recording of how to create a k0s instance.
+- [Create a k0s cluster](https://docs.k0sproject.io/main/create-cluster/) - For when you're ready to build a multi-node cluster.
+- [Run k0s in Docker](https://docs.k0sproject.io/main/k0s-in-docker/) - Run k0s controllers and workers in containers.
+- [Run in Windows](https://docs.k0sproject.io/main/experimental-windows/) - For running k0s on a windows host (experimental!).
+- You may also be interested in current version specifications. For docs, tutorials, and other k0s resources, see our Docs and Resources [main page](https://docs.k0sproject.io).
 
-
-![k0s demo](docs/img/k0s_demo.gif)
+## Join the Community
+If you'd like to help build k0s, please check out our guide to [Contributing](https://docs.k0sproject.io/main/contributors/overview/) and our [Code of Conduct](https://docs.k0sproject.io/main/contributors/CODE_OF_CONDUCT/).
 
 ## Motivation
 

docs/contributors/overview.md

@@ -6,24 +6,24 @@ When contributing to this repository, please consider first discussing the chang
 
 ## Code of Conduct
 Our code of conduct can be found in the link below. Please follow it in all your interactions with the project.
-* [Code Of Conduct](./CODE_OF_CONDUCT.md) 
+- [Code Of Conduct](./CODE_OF_CONDUCT.md) 
 
 ## Github Workflow
 We Use [Github Flow](https://guides.github.com/introduction/flow/index.html), so all code changes are tracked via Pull Requests.
 A detailed guide on the recommended workflow can be found below:
- * [Github Workflow](./github_workflow.md)
+- [Github Workflow](./github_workflow.md)
 
 ## Code Testing
 All submitted PRs go through a set of tests and reviews. You can run most of these tests *before* a PR is submitted.
 In fact, we recommend it, because it will save on many possible review iterations and automated tests.
 The testing guidelines can be found here:
-* [Contributor's Guide to Testing](./testing.md)
+- [Contributor's Guide to Testing](./testing.md)
 
 ## License
 By contributing, you agree that your contributions will be licensed as followed:
 
-* All content residing under the "docs/" directory of this repository is licensed under "Creative Commons Attribution Share Alike 4.0 International" (CC-BY-SA-4.0). See docs/LICENCE for details.
-* Content outside of the above mentioned directories or restrictions above is available under the "Apache License 2.0".
+- All content residing under the "docs/" directory of this repository is licensed under "Creative Commons Attribution Share Alike 4.0 International" (CC-BY-SA-4.0). See docs/LICENCE for details.
+- Content outside of the above mentioned directories or restrictions above is available under the "Apache License 2.0".
 
 ## Community
 Some of you might have noticed we have official community blog hosted on [Medium](https://medium.com/k0sproject). If you are not yet following us, we'd like to invite you to do so now! 

docs/internal/publishing_docs_using_mkdocs.md

@@ -0,0 +1,53 @@
+# Publishing Docs
+
+We use [mkdocs](https://www.mkdocs.org) and [mike](https://github.com/jimporter/mike) for publishing docs to [docs.k0sproject.io](https://docs.k0sproject.io).
+This guide will provide a simple how-to on how to configure and deploy newly added docs to our website.
+
+## Requirements
+Install mike: https://github.com/jimporter/mike#installation
+
+## Adding A New link to the Navigation
+- All docs must live under the `docs` directory (I.E., changes to the main `README.md` are not reflected in the website).
+- Add a new link under `nav` in the main [mkdocs.yml](https://github.com/k0sproject/k0s/blob/main/mkdocs.yml) file:
+    ```
+  nav:
+    - Overview: README.md
+    - Creating A Cluster:
+        - Quick Start Guide: create-cluster.md
+        - Run in Docker: k0s-in-docker.md
+        - Single node set-up: k0s-single-node.md
+    - Configuration Reference:
+        - Architecture: architecture.md
+        - Networking: networking.md
+        - Configuration Options: configuration.md
+        - Configuring Containerd: containerd_config.md
+        - Using A Custom CRI: custom-cri-runtime.md
+        - Using Cloud Providers: cloud-providers.md
+        - Running k0s with Traefik: examples/traefik-ingress.md
+        - Running k0s as a service: install.md
+        - k0s CLI Help Pages: cli/k0s.md
+    - Deploying Manifests: manifests.md
+    - FAQ: FAQ.md
+    - Troubleshooting: troubleshooting.md
+    - Contributing:
+        - Overview: contributors/overview.md
+        - Workflow: contributors/github_workflow.md
+        - Testing: contributors/testing.md
+    ```
+- Test your deployment locally, using `mike`:
+    ```
+    version="v0.9.0" # example
+    mike deploy ${version}
+    ```
+  
+    ```
+    mike set-default ${version}
+    ```
+  
+    ```
+    mike serve
+    ```
+    Your local version should be served under: http://localhost:8000.
+
+- Once your changes are pushed to `main`, the "Publish Docs" jos will start running: https://github.com/k0sproject/k0s/actions?query=workflow%3A%22Publish+docs+via+GitHub+Pages%22
+- You should see the deployment outcome in the `gh-pages` deployment page: https://github.com/k0sproject/k0s/deployments/activity_log?environment=github-pages    

docs/k0s-single-node.md

@@ -6,7 +6,7 @@ These instructions outline a quick method for running a local k0s master and wor
 ## Prepare Dependencies
 #### 1. Download the k0s binary
 ```sh
-curl -sSLf get.k0s.sh | sh
+curl -sSLf https://get.k0s.sh | sh
 ```
 
 #### 2. Download the kubectl binary

mkdocs.yml

@@ -14,6 +14,7 @@ nav:
       - Quick Start Guide: create-cluster.md
       - Run in Docker: k0s-in-docker.md
       - Single node set-up: k0s-single-node.md
+      - K0s in Windows (experimental): experimental-windows.md
   - Configuration Reference:
       - Architecture: architecture.md
       - Networking: networking.md