Skip to content

Commit

Permalink
Forward users to docs main site for k0s instructions
Browse files Browse the repository at this point in the history
Signed-off-by: Karen Almog <kalmog@mirantis.com>
  • Loading branch information
Karen Almog committed Dec 21, 2020
1 parent ed0e78a commit 763a269
Show file tree
Hide file tree
Showing 5 changed files with 17 additions and 15 deletions.
1 change: 1 addition & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ on:
push:
branches:
- main
pull_request:
release:
types:
- published
Expand Down
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,18 +23,18 @@ 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.
- 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

Expand Down
10 changes: 5 additions & 5 deletions docs/contributors/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -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!
Expand Down
2 changes: 1 addition & 1 deletion docs/k0s-single-node.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 763a269

Please sign in to comment.