Merge pull request #1396 from chef/im/update_workstation_docs

Docs overhaul

www/Makefile

@@ -24,7 +24,6 @@ chef_web_docs_submodule:
 	git submodule foreach git reset --hard
 	cp -R content/* chef-web-docs/_vendor/github.com/chef/chef-workstation/www/content
 	cp -R static/images/* chef-web-docs/_vendor/github.com/chef/chef-workstation/www/static/images
-	cp layouts/shortcodes/* chef-web-docs/_vendor/github.com/chef/chef-workstation/www/layouts/shortcodes/
 
 reset_chef_web_docs:
 	git submodule foreach git reset --hard

www/README.md

@@ -239,18 +239,19 @@ provide additional important information
 
 There are often cases where we want to maintain blocks of text that are identical
 from one page to the next. In those cases, we add that text, formatted in Markdown,
-to a shortcode file located in `chef-workstation/www/layouts/shortcodes`.
-
-Each shortcode in the Chef Workstation documentation must be prefixed with `ws_`.
-For example, `ws_shortcode_name.md`.
+to a shortcode file located in the `chef-web-docs` repo in
+`chef-web-docs/themes/docs-new/layouts/shortcodes`.
 
 To add that shortcode to a page in `chef-workstation/www/content`, add the file name,
 minus the .md suffix, wrapped in double curly braces and percent symbols to
 the location in the Markdown page where you want that text included. For example,
-if you want to add the text in `ws_shortcode_file_name.md` to a page, add
-`{{% ws_shortcode_file_name %}}` to the text of that page and it will appear when
+if you want to add the text in `shortcode_file_name.md` to a page, add
+`{{% shortcode_file_name %}}` to the text of that page and it will appear when
 Hugo rebuilds the documentation.
 
+To update or add a new shortcode to the Workstation documentation, submit a PR to
+`chef/chef-web-docs`. All shortcodes should be in `chef-web-docs/themes/docs-new/layouts/shortcodes`.
+
 **Shortcodes in lists**
 
 Hugo doesn't handle shortcodes that are indented in a list item properly. It interprets
@@ -326,6 +327,7 @@ aliases = ["/a_deleted_page/", "/another_deleted_page/"]
 ## Structure
 
 ### High Level
+
 ```
 .
 ├── Makefile    # contains helpers to quickly start up the development environment
@@ -334,18 +336,15 @@ aliases = ["/a_deleted_page/", "/another_deleted_page/"]
 ```
 
 ### Local Content
+
 ```
 .
 ├── site
 │   ├── content
 │   │   ├── workstation                 # where to keep markdown file documentation
-│   ├── layouts
-|   │   ├── shortcodes
-|   │   │   ├── ws_<shortcode_name>.md  # how to name your workstation-specific shortcodes
 |   ├── static
 |   |   ├── images
 |   |   |   ├── chef-workstation        # where to keep any images you need to reference in your documentation
-|   |   ├── css
 ```
 
 **Data**

www/content/workstation/_index.md

@@ -14,7 +14,7 @@ aliases = ["/about_workstation.html", "/about_chefdk.html", "/chef_dk.html", "/a
 
 [\[edit on GitHub\]](https://github.com/chef/chef-workstation/blob/master/www/content/workstation/_index.md)
 
-{{% ws_chef_workstation %}}
+{{% chef_workstation %}}
 
 Chef Workstation replaces ChefDK, combining all the existing features
 with new features, such as ad-hoc task support and the new Chef

www/content/workstation/chef_shell.md

@@ -14,13 +14,13 @@ aliases = ["/chef_shell.html", "/chef_shell/"]
 
 [\[edit on GitHub\]](https://github.com/chef/chef-workstation/blob/master/www/content/workstation/ctl_chef_shell.md)
 
-{{% ws_chef_shell_summary %}}
+{{% chef_shell_summary %}}
 
 The chef-shell executable is run as a command-line tool.
 
 ## Modes
 
-{{% ws_chef_shell_modes %}}
+{{% chef_shell_modes %}}
 
 ## Options
 
@@ -67,7 +67,7 @@ This command has the following options:
 
     {{< warning >}}
 
-    {{% ws_node_ctl_attribute %}}
+    {{% node_ctl_attribute %}}
 
     {{< /warning >}}
 
@@ -98,44 +98,44 @@ This command has the following options:
 
 ## Configure
 
-{{% ws_chef_shell_config %}}
+{{% chef_shell_config %}}
 
 ### chef-shell.rb
 
-{{% ws_chef_shell_config_rb %}}
+{{% chef_shell_config_rb %}}
 
 ### Run as a Chef Infra Client
 
-{{% ws_chef_shell_run_as_chef_client %}}
+{{% chef_shell_run_as_chef_client %}}
 
 ## Debugging Cookbooks
 
-{{% ws_chef_shell_breakpoints %}}
+{{% chef_shell_breakpoints %}}
 
 ### Step Through Run-list
 
-{{% ws_chef_shell_step_through_run_list %}}
+{{% chef_shell_step_through_run_list %}}
 
 ### Debug Existing Recipe
 
-{{< readFile_shortcode file="ws_chef_shell_debug_existing_recipe.md" >}}
+{{< readFile_shortcode file="chef_shell_debug_existing_recipe.md" >}}
 
 ### Advanced Debugging
 
-{{< readFile_shortcode file="ws_chef_shell_advanced_debug.md" >}}
+{{< readFile_shortcode file="chef_shell_advanced_debug.md" >}}
 
 ## Manipulating Chef Infra Server Data
 
-{{% ws_chef_shell_manage %}}
+{{% chef_shell_manage %}}
 
 ## Examples
 
 The following examples show how to use chef-shell.
 
 ### "Hello World"
 
-{{< readFile_shortcode file="ws_chef_shell_example_hello_world.md" >}}
+{{< readFile_shortcode file="chef_shell_example_hello_world.md" >}}
 
 ### Get Specific Nodes
 
-{{% ws_chef_shell_example_get_specific_nodes %}}
+{{% chef_shell_example_get_specific_nodes %}}

www/content/workstation/chefspec.md

@@ -14,7 +14,7 @@ aliases = ["/chefspec.html", "/chefspec/"]
 
 [\[edit on GitHub\]](https://github.com/chef/chef-workstation/blob/master/www/content/workstation/chefspec.md)
 
-{{% ws_chefspec_summary %}}
+{{% chefspec_summary %}}
 
 ChefSpec is a framework that tests resources and recipes as part of a
 simulated Chef Infra Client run. ChefSpec tests execute very quickly.

www/content/workstation/config_rb.md

@@ -362,7 +362,7 @@ Use the following setting to specify URLs that do not need a proxy:
 
 ## .d Directories
 
-{{% ws_config_rb_client_dot_d_directories %}}
+{{% config_rb_client_dot_d_directories %}}
 
 ## Optional Settings
 

www/content/workstation/config_yml_kitchen.md

@@ -26,7 +26,7 @@ data across any combination of platforms and test suites:
 -   Uses a comprehensive set of base images provided by
     [Bento](https://github.com/chef/bento)
 
-{{% ws_test_kitchen_yml %}}
+{{% test_kitchen_yml %}}
 
 {{< note >}}
 
@@ -38,7 +38,7 @@ about Test Kitchen.
 
 ## Syntax
 
-{{% ws_test_kitchen_yml_syntax %}}
+{{% test_kitchen_yml_syntax %}}
 
 ## Provisioner Settings
 
@@ -430,7 +430,7 @@ kitchen.yml file when the transport is WinRM:
 
 ### Work with Proxies
 
-{{< readFile_shortcode file="ws_test_kitchen_yml_syntax_proxy.md" >}}
+{{< readFile_shortcode file="test_kitchen_yml_syntax_proxy.md" >}}
 
 ## Chef Infra Client Settings
 
@@ -493,19 +493,19 @@ Specific `optional_settings: values` may be specified.
 
 ### Bento
 
-{{% ws_bento %}}
+{{% bento %}}
 
 ### Drivers
 
-{{% ws_test_kitchen_drivers %}}
+{{% test_kitchen_drivers %}}
 
 ### kitchen-vagrant
 
-{{% ws_test_kitchen_driver_vagrant %}}
+{{% test_kitchen_driver_vagrant %}}
 
-{{% ws_test_kitchen_driver_vagrant_settings %}}
+{{% test_kitchen_driver_vagrant_settings %}}
 
-{{% ws_test_kitchen_driver_vagrant_config %}}
+{{% test_kitchen_driver_vagrant_config %}}
 
 ## Examples