Re-arrange Readme according to github guides format
Github Guide Readme Format
@@ -14,6 +14,7 @@ Opinionated platform that runs on Kubernetes, that takes you from App to URL in
- [Installation](#installation)
- [Usage](#usage)
- [How the documentation is organized](#how-the-documentation-is-organized)
+ - [Reach Us](#reach-us)
- [Contributing](#contributing)
- [License](#license)
@@ -38,24 +39,30 @@ to use Kubernetes as a PaaS (Platform as a Service).
## Installation
-- [Install on K3d]()
-- [Install on GKE]()
+- [Install on K3d](./docs/user/tutorials/install_epinio_on_k3d.md) - Install K3d and then install epinio.
## Usage
-- [QuickStart]() - tutorial on how to create an org and push an application.
+- [QuickStart](./docs/user/tutorials/quickstart.md) - tutorial on how to create an org and push an application.
## How the documentation is organized
-Epinio documentation is organised into these four quadrants.
+Epinio documentation is organised into these four quadrants in the `./docs/` folder.
-**Tutorials** take you by the hand through a series of steps on how to install epinio in various kubernetes distros, how to push an application of various languages etc.
-**How-to-guides** How-to-guides explain steps to solve specific problems like how to create a redis database using epinio etc.
-**Topic guides** discuss components of Epinio at a very high level like about linkerd, traefik etc.
-**Reference** provides information about Epinio CLI docs and Epinio API docs.
+[Tutorials](./docs/user/tutorials/) take you by the hand through a series of steps that are useful for a beginner like how to install epinio in various kubernetes distros, how to push an application and an org.
-## Contributing
+[How-to-guides](./docs/user/howtos/) explain steps to solve specific problems like how to create a redis database using epinio etc.
+
+[Explanations](./docs/user/explanations/) discuss components of Epinio at a very high level like about linkerd, traefik etc.
+
+[References](./docs/user/references/) provides references about Epinio CLI docs and Epinio API docs.
+## Reach Us
+
+- Slack: #epinio on [Rancher Users](https://rancher-users.slack.com/)
+- Github: [Discuss](https://github.com/epinio/epinio/discussions/new)
+
+## Contributing
`Epinio` uses [Github Project](https://github.com/epinio/epinio/projects/1) for tracking issues. You can also find the issues currenlty being worked on in the `BackLog` section.
