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

[SHACK-358] update docs and navigation for chef.sh #245

Merged
merged 7 commits into from
Oct 2, 2018
Merged
2 changes: 2 additions & 0 deletions www/site/config.toml
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ title = "chef.sh (Chef Workstation)"
theme = "chef"
staticDir = ["./static", "../chef-sh"]

sectionPagesMenu = "main"

# To develop against a local copy of the chef hugo theme, uncomment this line
# and set the value to the parent directory of where you have checked out the
# chef-hugo-theme repository
Expand Down
4 changes: 0 additions & 4 deletions www/site/content/docs/_index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,3 @@
+++
title = "Sample Docs Page"
menu = "docs"
+++

This is not synced into chef-www, only the `chef-workstation` folder is. This file exists simply to make the main docs page not...empty. The content on this page will NOT be synced to `chef/chef-www`

7 changes: 7 additions & 0 deletions www/site/content/docs/chef-workstation/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@ inspec version: 2.1.72

The `chef-run` utility allows you to execute ad-hoc configuration updates on the systems you manage without needing to first set up a Chef server. With chef-run, you connect to servers over SSH or WinRM, and can apply single resources, recipes, or entire cookbooks directly from your local workstation.


### Example: Installing NTP Server

Chef Workstation combines the power of InSpec and chef-run to give you the ability to easily detect and correct issues on any target instance. A common task that an environment maintainer performs is ensuring that the Network Time Protocol (NTP) is installed, so clocks are kept in sync between servers. InSpec allows us to simply query whether the package is installed via its package resource:
Expand Down Expand Up @@ -82,3 +83,9 @@ Runs the `my_cookbook::my_recipe` cookbook against servers myhost1 through myhos
```bash
chef-run myhost[1:20] my_cookbook::my_recipe
```

#### Further Reading

* [Chef Run CLI Reference](https://chef.sh/docs/reference/chef-run/)
* [Introducing Chef Workstation](https://blog.chef.io/2018/05/23/introducing-chef-workstation/)
* [Chef Workstation - How We Made that Demo](https://blog.chef.io/2018/06/25/chef-workstation-how-we-made-that-demo/)
5 changes: 5 additions & 0 deletions www/site/content/docs/reference/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
+++
title = "Reference"
id = "reference"
menu = "docs"
+++
12 changes: 12 additions & 0 deletions www/site/content/docs/reference/berks.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
+++
title = "berks"
linkTitle = "berks"
[menu]
[menu.docs]
parent = "Reference"
weight = "100"
+++

We are in the process of migrating this documentation to its new home here on [chef.sh](https://chef.sh).

Until then, current `berks` documentation can be found on [docs.chef.io](https://docs.chef.io/berkshelf.html).
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
+++
title = "CLI Reference"
linkTitle = "chef-run"
title = "chef-run"
[menu]
[menu.docs]
parent = "Chef Workstation"
weight = "20"
parent = "Reference"
weight = "400"
+++

Chef-run is a tool to execute ad-hoc tasks using Chef.
`chef-run` is a tool to execute ad-hoc tasks on one or more target nodes using Chef.

`chef-run <TARGET[S]> <RESOURCE> <RESOURCE_NAME> [PROPERTIES] [FLAGS]`

Expand Down
12 changes: 12 additions & 0 deletions www/site/content/docs/reference/chef-shell.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
+++
title = "chef-shell"
linkTitle = "chef-shell"
[menu]
[menu.docs]
parent = "Reference"
weight = "500"
+++

We are in the process of migrating this documentation to its new home here on [chef.sh](https://chef.sh).

Until then, current `chef-shell` documentation can be found on [docs.chef.io](https://docs.chef.io/chef_shell.html).
12 changes: 12 additions & 0 deletions www/site/content/docs/reference/chef.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
+++
title = "chef"
linkTitle = "chef"
[menu]
[menu.docs]
parent = "Reference"
weight = "200"
+++

We are in the process of migrating this documentation to its new home here on [chef.sh](https://chef.sh).

Until then, current `chef` command documentation can be found on [docs.chef.io](https://docs.chef.io/about_chefdk.html), under the heading 'chef (executable).
12 changes: 12 additions & 0 deletions www/site/content/docs/reference/chefspec.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
+++
title = "chefspec"
linkTitle = "chefspec"
[menu]
[menu.docs]
parent = "Reference"
weight = "300"
+++

We are in the process of migrating this documentation to its new home here on [chef.sh](https://chef.sh).

Until then, current `chefspec` documentation can be found on [docs.chef.io](https://docs.chef.io/chefspec.html).
12 changes: 12 additions & 0 deletions www/site/content/docs/reference/inspec.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
+++
title = "inspec"
linkTitle = "inspec"
[menu]
[menu.docs]
parent = "Reference"
weight = "600"
+++

We are in the process of migrating this documentation to its new home here on [chef.sh](https://chef.sh).

Until then, current `inspec` documentation can be found on [inspec.io](https://www.inspec.io/docs/reference/cli/).
12 changes: 12 additions & 0 deletions www/site/content/docs/reference/kitchen.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
+++
title = "kitchen"
linkTitle = "kitchen"
[menu]
[menu.docs]
parent = "Reference"
weight = "700"
+++

We are in the process of migrating this documentation to its new home here on [chef.sh](https://chef.sh).

Until then, current `kitchen` documentation can be found on [docs.chef.io](https://docs.chef.io/ctl_kitchen.html).