[SHACK-358] update docs and navigation for chef.sh #245
Conversation
| @@ -0,0 +1,12 @@ | |||
| +++ | |||
| title = "Tools Reference - berks" | |||
There was a problem hiding this comment.
Seems overkill to have Tools Reference on each page when that will be clearly indicated by the Nav
There was a problem hiding this comment.
I went back and forth on that - what I actually wanted was to get the full name in the title, "Chef Workstation Tools Reference - TOOLNAME", while the menu item and the page heading just have the tool name.
I'll push the update to be just the tool name, and can open another card to straighten out titles on the browser titlebar (which will be only TOOLNAME with that change), vs what's shown on the menu and in the content.
There was a problem hiding this comment.
Updated, new screencaps inbound
marcparadise
force-pushed
the
SHACK-358/update-docs-and-navigation
branch
from
b587192
to
943e6f6
Compare
|
I'd like to just call it "Reference", in keeping with our other docs sites. |
|
@kagarmoe thanks, I've updated and refreshed the screen captures. This also updates the slug, which isn't in the capture - they're now looking like this:
|
marcparadise
force-pushed
the
SHACK-358/update-docs-and-navigation
branch
from
943e6f6
to
a58ac1f
Compare
This commit restructures the CLI reference documents to be under the heading "Tools Reference" and adds placeholders for key chefdk tools. Previously, the "CLI REference" heading was under "Chef Workstation" and contained only the chef-run CLI reference. This change puts Workstation tool CLI reference docs under a single heading to make them easier to find. The reference doc for chef-run is complete, but the other components currently contain links over the their docs.chef.io (or inspec.io/docs) counterparts. Signed-off-by: Marc A. Paradise <marc.paradise@gmail.com>
Signed-off-by: Marc A. Paradise <marc.paradise@gmail.com>
Signed-off-by: Marc A. Paradise <marc.paradise@gmail.com>
marcparadise
force-pushed
the
SHACK-358/update-docs-and-navigation
branch
from
a58ac1f
to
74bfff9
Compare
|
@kagarmoe I'd like to get your sign off before we merge this. |
Description
This restructures the CLI reference documents to be under the
heading "Tools Reference" and adds placeholders for key chefdk tools.
Previously, the "CLI Reference" heading was under "Chef Workstation" and
contained only the chef-run CLI reference. This change puts Workstation
tool CLI reference docs under a single heading to make them easier to
find.
The reference doc for chef-run is complete, but the other components currently
contain links over the their docs.chef.io (or inspec.io/docs)
counterparts until the docs migration effort is complete.
Check List
www/site/content/docs/has been updated with any relevant changes: