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.
This repository contains the documentation for Deis Workflow which is the second major release of the Platform.
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].
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.
- Fork this repository
- Make your changes
- [Submit a pull request][prs] (PR) to this repository with your changes, and unit tests whenever possible
- If your PR fixes any [issues][issues], make sure you write
Fixes #1234in your PR description (where#1234is the number of the issue you're closing)
- If your PR fixes any [issues][issues], make sure you write
- The Deis core contributors will review your code. After each of them sign off on your code, they'll label your PR with
LGTM1andLGTM2(respectively). Once that happens, a contributor will merge it
The documentation site requires either a local installation of [MkDocs][] or access to Docker.
Install [MkDocs][] and required dependencies:
make deps
To build the documentation run: make build or make docker-build
To serve documenation run: make serve or make docker-serve
Then view the documentation on http://localhost:8000 or http://DOCKER_IP:8000.
Copyright 2013, 2014, 2015 Engine Yard, Inc.
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
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.
[k8s-home]: [k8s-home]: http://kubernetes.io [install-k8s]: http://kubernetes.io/gettingstarted/ [mkdocs]: http://www.mkdocs.org/ [issues]: https://github.com/deis/workflow/issues [prs]: https://github.com/deis/workflow/pulls