Skip to content

doc(README.md): modifying the readme to reflect beta status#84

Merged
arschles merged 5 commits into
deis:masterfrom
arschles:readme-beta
Mar 16, 2016
Merged

doc(README.md): modifying the readme to reflect beta status#84
arschles merged 5 commits into
deis:masterfrom
arschles:readme-beta

Conversation

@arschles

Copy link
Copy Markdown
Member

Comment thread README.md Outdated
## License

Copyright 2013, 2014, 2015 Engine Yard, Inc.
Copyright 2013, 2014, 2015,2016 Engine Yard, Inc.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

missing an extra space for consistency

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks! fixed in bd99603

Comment thread README.md Outdated
# About

This package provides a [Minio](http://minio.io) S3-compatible object storage system on Kubernetes. It can be used as a [Deis](https://deis.com/) component to provide object storage for various other components, but it is flexible enough to be run anywhere else.
The Deis minio component provides a [Minio](http://minio.io) server that can be run on Kubernetes. It's intended for use within the [Deis v2 platform](http://docs-v2.readthedocs.org/en/latest/) as an object storage server, but it's flexible enough to be run as a standalone pod on any Kubernetes cluster.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Minio provides a standalone S3 based object storage server

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

good call, fixed in c33e30a

@smothiki

Copy link
Copy Markdown
Contributor

ping @kmala
Everything look fine other than my above comment . Leaving LGTMs to doc gurus again

Comment thread README.md

We provide it as a Docker container, and also provide the following manifests to run it inside [Kubernetes](http://kubernetes.io/):
Currently, we aren't providing this component with any kind of persistent storage, but it may work with [persistent volumes](http://kubernetes.io/docs/user-guide/volumes/).

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Before this it's better we mention. Minio backs deis-registry and builder

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also database ??

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed in 7b70b29

@arschles

Copy link
Copy Markdown
Member Author

Thanks @smothiki

Comment thread README.md Outdated
applications on your own servers. Deis builds on [Kubernetes](http://kubernetes.io/) to provide
a lightweight, [Heroku-inspired](http://heroku.com) workflow.
Deis (pronounced DAY-iss) is an open source PaaS that makes it easy to deploy and manage applications on your own servers. Deis builds on [Kubernetes](http://kubernetes.io/) to provide
a lightweight, easy and secure way to deploy your code to production.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I feel like this section needs to be reworded to accurately reflect that Deis Workflow is the PaaS.

Here's how it has been worded in docs-v2:

Deis (pronounced DAY-iss) Workflow is an open source Platform as a Service (PaaS) that adds a developer-friendly layer to any Kubernetes cluster, making it easy to deploy and manage applications on your own servers.

https://github.com/deis/docs-v2/blob/master/src/index.md

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@krancour thanks for that. fixed in e6633a6 and noted in deis/builder#259 to be fixed, as that README has already been refactored and merged

arschles added a commit that referenced this pull request Mar 16, 2016
doc(README.md): modifying the readme to reflect beta status
@arschles arschles merged commit acc85c8 into deis:master Mar 16, 2016
@arschles arschles deleted the readme-beta branch March 16, 2016 15:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants