summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTim Smith <tsmith@chef.io>2016-08-10 20:55:36 -0700
committerTim Smith <tsmith@chef.io>2016-08-10 20:55:36 -0700
commitb1b295e60e26bb5316b27649348da1b6ba2dc614 (patch)
tree189eae2f0c3d61566cd905e07aba04f97c2acbb2
parent6474554cf70f17387c5a88be547dade30f3e13ee (diff)
downloadchef-b1b295e60e26bb5316b27649348da1b6ba2dc614.tar.gz
Additional readme updates
Signed-off-by: Tim Smith <tsmith@chef.io>
-rw-r--r--CONTRIBUTING.md2
-rw-r--r--README.md16
2 files changed, 9 insertions, 9 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index edf3e7428d..4f9f527381 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -26,7 +26,7 @@ Chef is built to last. We strive to ensure high quality throughout the Chef expe
The Chef Code Review process happens on Github pull requests. See [this article](https://help.github.com/articles/using-pull-requests) if you're not familiar with Github Pull Requests.
-Once you a pull request, the **Chef Engineering Team** or **Chef Core Committers** will review your code and respond to you with any feedback they might have. The process at this point is as follows:
+Once you open a pull request, the **Chef Engineering Team** or **Chef Core Committers** will review your code and respond to you with any feedback they might have. The process at this point is as follows:
1. 2 thumbs-ups are required from the **Chef Engineering Team** or **Chef Core Committers** for all merges.
2. When ready, your pull request will be tagged with label `Ready For Merge`.
diff --git a/README.md b/README.md
index 70aa52d806..6eb0c2705b 100644
--- a/README.md
+++ b/README.md
@@ -36,9 +36,9 @@ Install these via your platform's preferred method (`apt`, `yum`, `ports`,
* git
* C compiler, header files, etc. On Ubuntu/Debian, use the
`build-essential` package.
-* ruby 2.0.0 or later
+* ruby 2.1.0 or later
* rubygems
-* bundler
+* bundler gem
### Chef Installation
@@ -75,10 +75,10 @@ The general development process is:
4. Push your feature branch to github and open a pull request against
master.
-Once your repository is set up, you can start working on the code. We do use
-TDD with RSpec, so you'll need to get a development environment running.
-Follow the above procedure ("Installing from Git") to get your local
-copy of the source running.
+Once your repository is set up, you can start working on the code. We do utilize
+RSpec for test driven development, so you'll need to get a development
+environment running. Follow the above procedure ("Installing from Git") to get
+your local copy of the source running.
## Reporting Issues
@@ -140,12 +140,12 @@ Chef is an amalgam of many components. These components update all the time, nec
## Chef Packages
-Chef is distributed as packages for debian, rhel, ubuntu, windows and os/x. It includes a large number of components from various sources, and these are versioned and maintained separately from chef project, which bundles them all together conveniently for the user.
+Chef is distributed as packages for debian, rhel, ubuntu, windows, solaris, aix, and os x. It includes a large number of components from various sources, and these are versioned and maintained separately from chef project, which bundles them all together conveniently for the user.
These packages go through several milestones:
- `master`: When code is checked in to master, the patch version of chef is bumped (e.g. 0.9.10 -> 0.9.11) and a build is kicked off automatically to create and test the packages in Chef's Jenkins cluster.
- `unstable`: When a package is built, it enters the unstable channel. When all packages for all OS's have successfully built, the test phase is kicked off in Jenkins across all supported OS's. These builds are password-protected and generally only available to the test systems.
-- `current`: If the packages pass all the tests on all supported OS's, it is promoted as a unit to `current`, and is available via Chef's artifactory by running `curl https://omnitruck.chef.io/install.sh | sudo bash -s -- -c current -P chef`
+- `current`: If the packages pass all the tests on all supported OS's, it is promoted as a unit to `current`, and is available via Chef's artifactory by running `curl https://www.chef.io/chef/install.sh | sudo bash -s -- -c current -P chef`
- `stable`: Periodically, Chef will pick a release to "bless" for folks who would like a slower update schedule than "every time a build passes the tests." When this happens, it is manually promoted to stable and an announcement is sent to the list. It can be reached at https://downloads.chef.io or installed using the `curl` command without specifying `-c current`. Packages in `stable` are no longer available in `current`.
Additionally, periodically Chef will update the desired versions of chef components and check that in to `master`, triggering a new build with the updated components in it.