Skip to content

Commit 7bdd02a

Browse files
committed
Merge pull request #148 from slack/update-readme
doc(readme): help readme function as a landing page
2 parents abd3279 + 78eab28 commit 7bdd02a

1 file changed

Lines changed: 24 additions & 20 deletions

File tree

README.md

Lines changed: 24 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,38 @@
1-
# Deis Workflow Documentation
1+
![](https://deis.com/images/deis-logo.png)
22

3-
[![Build Status](https://travis-ci.org/deis/workflow.svg?branch=master)](https://travis-ci.org/deis/workflow)
4-
[![Latest Docs](http://img.shields.io/badge/docs-latest-fc1e5e.svg)](http://docs-v2.readthedocs.org/en/latest/)
3+
**Deis Workflow** is an open source Platform as a Service (PaaS) that adds a developer-friendly layer to any [Kubernetes][k8s-home] cluster, making it easy to deploy and manage applications.
54

6-
Deis (pronounced DAY-iss) Workflow is an open source Platform as a Service (PaaS) that adds a developer-friendly layer to any [Kubernetes][k8s-home] cluster, making it easy to deploy and manage applications on your own servers.
5+
If you are looking to **get started** with **Deis Workflow** read the [Quick Start Guide](src/installing-workflow/quickstart.md) in this repository or on [Read the Docs](https://docs-v2.readthedocs.org/en/latest/).
76

8-
## Beta Status
7+
Visit [https://deis.com](https://deis.com) for more information on [why you should use Deis Workflow](https://deis.com/why-deis/) or [its features](https://deis.com/how-it-works/).
98

10-
Many Deis components are currently in beta status, as are these docs, and we welcome your input! If you have feedback, please [submit an issue][issues]. If you'd like to participate in development, please read the "Development" section below and [submit a pull request][prs].
9+
This repository contains the source code for Deis Workflow documentation. If you're looking for individual components, they live in their own repositories.
1110

12-
# About
11+
Please see below for links and descriptions of each component:
1312

14-
This repository contains the documentation for Deis Workflow which is the second major release of the Platform. If you're looking for the Deis components themselves, each is in its own repository. Please refer to the below list for links and descriptions for each.
15-
16-
- [controller](https://github.com/deis/controller) - The central API
17-
- [builder](https://github.com/deis/builder) - The git server
13+
- [controller](https://github.com/deis/controller) - Workflow API server
14+
- [builder](https://github.com/deis/builder) - Git server and source-to-image component
1815
- [dockerbuilder](https://github.com/deis/dockerbuilder) - The builder for [Docker](https://www.docker.com/) based applications
19-
- [slugbuilder](https://github.com/deis/slugbuilder) - The builder for [slug](https://devcenter.heroku.com/articles/slug-compiler) based applications
20-
- [slugrunner](https://github.com/deis/slugrunner) - The runner for slug based applications
21-
- [fluentd](https://github.com/deis/fluentd) - The log shipping mechanism
16+
- [slugbuilder](https://github.com/deis/slugbuilder) - The builder for [slug/buildpack](https://devcenter.heroku.com/articles/slug-compiler) based applications
17+
- [slugrunner](https://github.com/deis/slugrunner) - The runner for slug/buildpack based applications
18+
- [fluentd](https://github.com/deis/fluentd) - Backend log shipping mechanism for `deis logs`
2219
- [postgres](https://github.com/deis/postgres) - The central database
2320
- [registry](https://github.com/deis/registry) - The Docker registry
24-
- [logger](https://github.com/deis/logger) - The (in-memory) log buffer
25-
- [monitor](https://github.com/deis/monitor) - The monitoring mechanism
26-
- [router](https://github.com/deis/router) - The edge router
21+
- [logger](https://github.com/deis/logger) - The (in-memory) log buffer for `deis logs`
22+
- [monitor](https://github.com/deis/monitor) - The platform monitoring components
23+
- [router](https://github.com/deis/router) - The HTTP/s edge router
2724
- [minio](https://github.com/deis/minio) - The in-cluster, ephemeral, development-only object storage system
28-
- [workflow-cli](https://github.com/deis/workflow-cli) - The command line interface (CLI)
25+
- [workflow-cli](https://github.com/deis/workflow-cli) - Workflow CLI `deis`
2926
- [workflow-e2e](https://github.com/deis/workflow-e2e) - End-to-end tests for the entire platform
3027

31-
# Development
28+
## Beta Status
29+
30+
Many Deis components are currently in beta status and we welcome your input! If you have feedback, please [submit an issue][issues]. If you'd like to participate in development, please read the "Working on Documentation" section below and [submit a pull request][prs].
31+
32+
# Working on Documentation
33+
34+
[![Build Status](https://travis-ci.org/deis/workflow.svg?branch=master)](https://travis-ci.org/deis/workflow)
35+
[![Latest Docs](http://img.shields.io/badge/docs-latest-fc1e5e.svg)](http://docs-v2.readthedocs.org/en/latest/)
3236

3337
The Deis project welcomes contributions from all developers. The high level process for development matches many other open source projects. See below for an outline.
3438

@@ -54,7 +58,7 @@ make deps
5458

5559
To build the documentation run: `make build` or `make docker-build`
5660

57-
## Serve Documentation
61+
## Serve Documentation Locally
5862

5963
To serve documenation run: `make serve` or `make docker-serve`
6064

0 commit comments

Comments
 (0)