Skip to content

Commit 49f88ca

Browse files
committed
Merge pull request #107 from arschles/readme-beta
doc(README.md): update readme to reflect beta status
2 parents d46a0ad + 4c28419 commit 49f88ca

1 file changed

Lines changed: 21 additions & 9 deletions

File tree

README.md

Lines changed: 21 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -3,19 +3,29 @@
33
[![Build Status](https://travis-ci.org/deis/workflow.svg?branch=master)](https://travis-ci.org/deis/workflow)
44
[![Latest Docs](http://img.shields.io/badge/docs-latest-fc1e5e.svg)](http://docs-v2.readthedocs.org/en/latest/)
55

6-
## About
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.
77

8-
Deis (pronounced DAY-iss) is an open source PaaS that makes it easy to deploy and manage
9-
applications on your own servers. Deis builds on [Kubernetes](http://kubernetes.io/) to provide
10-
a lightweight, [Heroku-inspired](http://heroku.com) workflow.
8+
# About
119

12-
This repository represents the documentation for Deis Workflow which is the
13-
second major release of the Platform.
10+
This repository contains the documentation for Deis Workflow which is the second major release of the Platform.
11+
12+
## Beta Status
13+
14+
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].
15+
16+
# Development
17+
18+
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.
19+
20+
* Fork this repository
21+
* Make your changes
22+
* [Submit a pull request][prs] (PR) to this repository with your changes, and unit tests whenever possible
23+
* If your PR fixes any [issues][issues], make sure you write `Fixes #1234` in your PR description (where `#1234` is the number of the issue you're closing)
24+
* The Deis core contributors will review your code. After each of them sign off on your code, they'll label your PR with `LGTM1` and `LGTM2` (respectively). Once that happens, a contributor will merge it
1425

1526
## Requirements
1627

17-
The documentation site requires either a local installation of [MkDocs][] or
18-
access to Docker.
28+
The documentation site requires either a local installation of [MkDocs][] or access to Docker.
1929

2030
### Local Installation
2131

@@ -43,6 +53,8 @@ Licensed under the Apache License, Version 2.0 (the "License"); you may not use
4353

4454
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
4555

46-
56+
[k8s-home]: [k8s-home]: http://kubernetes.io
4757
[install-k8s]: http://kubernetes.io/gettingstarted/
4858
[mkdocs]: http://www.mkdocs.org/
59+
[issues]: https://github.com/deis/workflow/issues
60+
[prs]: https://github.com/deis/workflow/pulls

0 commit comments

Comments
 (0)