Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
30 commits
Select commit Hold shift + click to select a range
cf8ac8a
Initial content migration
IanMadd Aug 12, 2025
41dfb3c
It renders now
IanMadd Aug 13, 2025
6b607f7
More organization work
IanMadd Aug 13, 2025
08cd788
Update vale lint gh action
IanMadd Oct 13, 2025
086552a
Very WIP
IanMadd Jan 15, 2026
ea8aa24
Remove Workstation content
IanMadd Jan 15, 2026
9d0c2d9
More editing and organization
IanMadd Jan 19, 2026
89e0901
Update Client run text
IanMadd Jan 21, 2026
2c29116
Markdownlint fixes
IanMadd Jan 21, 2026
4687839
Cspell fixes
IanMadd Jan 21, 2026
ff9a3f6
Clean up vale lints
IanMadd Jan 22, 2026
e4d1b49
Link fixes
IanMadd Jan 23, 2026
ad8c85d
Agentless updates
IanMadd Jan 20, 2026
357ca32
License content
IanMadd Jan 20, 2026
d699e0b
Install content
IanMadd Jan 20, 2026
6e1d548
Fixes
IanMadd Jan 20, 2026
2dc3745
Linting fixes
IanMadd Jan 23, 2026
be6caab
Small corrections to agentless docs (#126)
neha-p6 Jan 23, 2026
733e27a
Remove nonexistent resource #128
IanMadd Jan 23, 2026
ecbe5a3
Update vale config (#130) (#131)
github-actions[bot] Jan 26, 2026
6323cc7
add example for using runlist in target mode (#124) (#133)
github-actions[bot] Jan 26, 2026
dafcadf
Fix cspell ignore
IanMadd Jan 26, 2026
8b71919
changes made in migrate tool section as per the latest functional cha…
varunsharma5 Jan 27, 2026
9c3456d
Remove terraform provider doc (#135)
IanMadd Jan 28, 2026
82a51a2
Update resource YAML files
IanMadd Jan 29, 2026
1156774
Update reusable text files used with resources
IanMadd Jan 29, 2026
9db35ce
Update resource data files
IanMadd Jan 29, 2026
aebe3c8
Update layouts
IanMadd Jan 29, 2026
1bc19aa
Minor updates
IanMadd Jan 29, 2026
a18e7ea
cspell lint fixes
IanMadd Jan 30, 2026
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
6 changes: 3 additions & 3 deletions .github/workflows/lint.yml
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ jobs:
- uses: carlosperate/download-file-action@v1.1.2
id: download-mdl-config
with:
file-url: 'https://raw.githubusercontent.com/chef/chef-web-docs/main/.markdownlint.yaml'
file-url: 'https://raw.githubusercontent.com/chef/chef-client-docs/main/.markdownlint.yaml'
file-name: 'markdownlint.yaml'
- uses: DavidAnson/markdownlint-cli2-action@v5
with:
Expand All @@ -57,7 +57,7 @@ jobs:
- uses: actions/checkout@v3
- uses: errata-ai/vale-action@reviewdog
with:
files: '["archetypes", "content", "layouts"]'
vale_flags: "--config=tools/vale/.vale-github-action.ini"
files: '["content", "layouts"]'
vale_flags: "--config=.vale.ini --minAlertLevel=error"
filter_mode: diff_context
fail_on_error: true
3 changes: 3 additions & 0 deletions .vale.ini
Original file line number Diff line number Diff line change
Expand Up @@ -16,3 +16,6 @@ BasedOnStyles = chef, Microsoft, vale, write-good

# Ignore SVG markup
TokenIgnores = (\*\*\{\w*\}\*\*), (Master License and Services Agreement)

# Modify rule alert levels
write-good.ThereIs = warning
206 changes: 183 additions & 23 deletions config/_default/menu.toml
Original file line number Diff line number Diff line change
Expand Up @@ -60,35 +60,195 @@ title = "Install"
identifier = "install"

[[install]]
title = "Migration tool"
identifier = "install/migration_tool"
title = "Installer"
identifier = "install/installer"
parent = "install"
weight = 20

[[install]]
title = "Native installer"
identifier = "install/installer"
title = "Migration Tool"
identifier = "install/migration_tool"
parent = "install"
weight = 30

[[licensing]]
title = "Licensing"
identifier = "licensing"

[[agentless]]
title = "Agentless"
identifier = "agentless"

[[workstation]]
title = "Chef Workstation"
identifier = "workstation"

[[workstation]]
title = "Knife"
identifier = "workstation/knife"
parent = "workstation"
weight = 100

[[workstation]]
title = "Test Kitchen Enterprise"
identifier = "workstation/tke"
parent = "workstation"
weight = 200
[[features]]
title = "Features"
identifier = "features"

[[features]]
title = "Agentless Mode"
identifier = "features/agentless"
parent = "features"

[[features]]
title = "Resources"
identifier = "features/agentless/resources"
parent = "features/agentless"
weight = 40

[[features]]
title = "Chef Solo"
identifier = "features/chef_solo"
parent = "features"

[[features]]
title = "Ohai"
identifier = "features/ohai"
parent = "features"

[[integrations]]
title = "Integrations"
identifier = "integrations"

[[integrations]]
title = "Azure"
identifier = "integrations/azure"
parent = "integrations"

[[integrations]]
title = "Windows"
identifier = "integrations/windows"
parent = "integrations"

[[policy]]
title = "Policy"
identifier = "policy"

[[security]]
title = "Security"
identifier = "security"

[[cookbooks]]
title = "Cookbooks"
identifier = "cookbooks"

[[cookbooks]]
title = "Attributes"
identifier = "cookbooks/attributes"
parent = "cookbooks"
weight = 30

[[cookbooks]]
title = "Recipes"
identifier = "cookbooks/recipes"
parent = "cookbooks"
weight = 70

[[infra_language]]
title = "Infra language"
identifier = "infra_language"

[[resources]]
title = "Resources"
identifier = "resources"

[[resources]]
title = "Bundled resources"
parent = "resources"
identifier = "resources/bundled"

[[resources]]
title = "Custom resources"
parent = "resources"
identifier = "resources/custom"

[[extension_apis]]
title = "Extension APIs"
identifier = "extension_apis"

[[extension_apis]]
title = "Compliance DSL"
identifier = "extension_apis/inspec/dsl_inspec/ Compliance DSL"
parent = "extension_apis"
url = "https://docs.chef.io/inspec/latest/profiles/controls/"
weight = 20

[[extension_apis]]
title = "Handlers"
identifier = "extension_apis/handlers"
parent = "extension_apis"
weight = 20

[[extension_apis]]
title = "Custom handlers"
identifier = "extension_apis/handlers/handlers.md#custom-handlers Custom Handlers"
parent = "extension_apis/handlers"
url = "/features/handlers/#custom-handlers"
weight = 10

[[extension_apis]]
title = "Community handlers"
identifier = "extension_apis/handlers/plugin_community.md#handlers Community Handlers"
parent = "extension_apis/handlers"
url = "/extension_apis/community_plugins/#handlers"
weight = 30

[[extension_apis]]
title = "Ohai plugins"
identifier = "extension_apis/ohai_plugins"
parent = "extension_apis"
weight = 40

[[reference]]
title = "Reference"
identifier = "reference"

[[reference]]
title = "chef-solo (executable)"
identifier = "reference/ctl_chef_solo.md chef-solo (executable)"
parent = "reference"
url = "/features/chef_solo/ctl_chef_solo/"
weight = 20

[[reference]]
title = "Handler DSL"
identifier = "reference/dsl_handler.md Handler Commands"
parent = "reference"
url = "/extension_apis/dsl_handler/"
weight = 40

[[reference]]
title = "ohai (executable)"
identifier = "reference/ctl_ohai.md ohai (executable)"
parent = "reference"
url = "/features/ohai/ctl_ohai/"
weight = 50

[[reference]]
title = "supermarket-ctl"
identifier = "supermarket/reference/ctl_supermarket.md supermarket-ctl"
parent = "reference"
url = "https://docs.chef.io/supermarket/ctl_supermarket/"
weight = 60

[[reference]]
title = "client.rb"
identifier = "reference/config_rb_client.md client.rb"
parent = "reference"
url = "/install/config_rb_client/"
weight = 70

[[reference]]
title = "metadata.rb"
identifier = "reference/config_rb_metadata.md metadata.rb"
parent = "reference"
url = "/cookbooks/config_rb_metadata/"
weight = 80

[[reference]]
title = "Policyfile.rb"
identifier = "reference/config_rb_policyfile.md Policyfile.rb"
parent = "reference"
url = "/policy/config_rb_policyfile/"
weight = 90

[[reference]]
title = "solo.rb"
identifier = "reference/config_rb_solo.md solo.rb"
parent = "reference"
url = "/install/config_rb_solo/"
weight = 100
21 changes: 20 additions & 1 deletion config/_default/params.toml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,22 @@
# Menus are defined in the /config/_default/menu.toml file
#######

menuOrder = ["landing_page", "install", "licensing", "agentless", "workstation", "resources", "chef_gem_server", "cookbooks", "reference", "release_notes"]
menuOrder = [
"overview",
"install",
"licensing",
"quickstart",
"features",
"policy",
"integrations",
"security",
"cookbooks",
"infra_language",
"resources",
"extension_apis",
"troubleshooting",
"reference"
]

#######
# robots = The default robots config applied to each page in the robots meta tag.
Expand All @@ -26,6 +41,10 @@ robots = ''
#######
breadcrumbs = true

[[breadcrumb_base]]
breadcrumb = "Documentation"
url = "https://docs.chef.io"

#######
#
# Settings for the link and image render hooks.
Expand Down
4 changes: 0 additions & 4 deletions config/branch-deploy/params.toml
Original file line number Diff line number Diff line change
@@ -1,5 +1 @@
breadcrumbs = true

[[breadcrumb_base]]
breadcrumb = "Docs"
url = "https://docs.chef.io"
2 changes: 2 additions & 0 deletions config/vocabularies/Chef/accept.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Chef Backend
[B|b]ackend
Loading