+++ title = "Chef Documentation Style Guide" draft = false gh_repo = "chef-web-docs" aliases = ["/style_guide.html", "/style_index/", "/style_guide/"]
[cascade] product = []
[menu] [menu.overview] title = "Docs Style" identifier = "overview/style/Docs Style" parent = "overview/style" weight = 10 +++
This style guide provides a set of standards for writing clear and consistent developer documentation for all of Progress Chef's products.
Chef's documentation is open source and we follow a docs as code methodology. Any community member can make or suggest a documentation change through a pull request or issue in a documentation repository.
For additional guidance not covered in this style guide, refer to Google's style guide and Microsoft's style guide.
Our main repository for docs.chef.io is called chef-web-docs. This repo contains the files for Chef Infra Client and the Hugo files for our front-end theme, templates, and shortcodes. The Chef documentation is located in: https://github.com/chef/chef-web-docs
- The
chef-web-docsrepo contains acontentdirectory which holds most the Markdown files in the doc set. - The
static/imagesdirectory stores the image files used in the docs. - The
config.tomltells Hugo how to build the navigation menus and contains other Hugo settings. do not modify this file.
We try to keep our documentation source as close to the code as possible, which means that our documentation files are distributed across several product repositories.