Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updates "about.md" for Workstation #276

Merged
merged 3 commits into from
Oct 16, 2018
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 46 additions & 6 deletions www/site/content/docs/chef-workstation/about.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,21 +6,36 @@ title = "About Chef Workstation"
weight= "30"
+++

Start your infrastructure automation quickly and easily with Chef Workstation. Chef Workstation give you everything you need to get started with Chef--ad hoc remote execution, remote scanning, configuration tasks, cookbook creation tools as well as robust dependency and testing software--all in one easy-to-install package.
Start your infrastructure automation quickly and easily with Chef Workstation.
Chef Workstation gives you everything you need to get started with Chef — ad hoc
remote execution, remote scanning, configuration tasks, cookbook creation tools
as well as robust dependency and testing software — all in one easy-to-install
package.

Chef Workstation replaces ChefDK, combining all the existing features with the added Chef Workstation feature of running ad-hoc tasks. In the future, Chef will develop and improve Chef Workstation and maintain ChefDK in its current state.
Chef Workstation replaces ChefDK, combining all the existing features with
new features, such as ad-hoc task support and the new Chef Workstation desktop
application. Chef will continue to maintain ChefDK, but new development will
take place in Chef Workstation without backporting features.

## Open Source

We're keeping the tradition of open source development in Chef. You'll find the Chef Workstation source code on [GitHub](https://github.com/chef/chef-workstation). We're releasing Chef Workstation under the open source [Apache 2.0 license](https://github.com/chef/chef-workstation/blob/master/LICENSE).
We're keeping the tradition of open source development in Chef. You'll find the
Chef Workstation source code on
[GitHub](https://github.com/chef/chef-workstation). We're releasing Chef
Workstation under the open source [Apache 2.0
license](https://github.com/chef/chef-workstation/blob/master/LICENSE).

### Contributing to Chef Workstation

We always welcome (and deeply appreciate!) new contributions to the project. The best way to start contributing to Chef Workstation is to provide us with in-depth feedback by creating GitHub issues.
We always welcome (and deeply appreciate!) new contributions to the project.
The best way to start contributing to Chef Workstation is to provide us with
in-depth feedback by creating GitHub issues.

See the guidelines for [community contributions](https://docs.chef.io/community_contributions.html) and our [community guidelines](https://docs.chef.io/community_guidelines.html) for keeping the development of the project awesome for all contributors.
See the [Community Contribution Guidelines](https://docs.chef.io/community_contributions.html)
and our [community guidelines](https://docs.chef.io/community_guidelines.html) for
keeping the development of the project awesome for all contributors.

### Supported Platforms
## Supported Platforms

Supported Host Operating Systems:

Expand All @@ -42,3 +57,28 @@ Supported Target Operating Systems:
| SUSE Enterprise Linux Server | 11 SP4, 12 SP1+ |
| Ubuntu | 14.04, 16.04, 18.04 |
| Debian | 7.x, 8.x, 9.x |

## System Requirements

### Chef Workstation

#### Minimum

* RAM: 2GB
* Disk: 4GB
* Running minimum settings may limit your ability to take advantage of Chef Workstation tools such as Test Kitchen which creates and manages virtualized test environments.

#### Recommended

* RAM: 4GB
* Disk 8GB

#### Chef Workstation App

* Linux:
* You must have a graphical window manager running
* the libraries TODO and TODO must be installed in order to run the included
Chef Workstation App. Install these using your distribution's package
manager.
* Windows: No additional requirements
* Mac: No additional requirements