diff options
| author | Neha Pansare <neha.pansare@progress.com> | 2022-07-04 18:09:24 +0530 |
|---|---|---|
| committer | Neha Pansare <neha.pansare@progress.com> | 2022-07-04 18:09:24 +0530 |
| commit | 2b433ba2197a4ca80a8e6900056ac748d924f583 (patch) | |
| tree | f440d55de8682eb00003e53a5468be44fcd4d8b8 | |
| parent | fb016af5f4843cc0e44ca37abf13e29cd0659674 (diff) | |
| download | chef-2b433ba2197a4ca80a8e6900056ac748d924f583.tar.gz | |
Fix linting issues
Signed-off-by: Neha Pansare <neha.pansare@progress.com>
| -rw-r--r-- | docs/dev/how_to/adding_documentation_to_infra_resources.md | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/docs/dev/how_to/adding_documentation_to_infra_resources.md b/docs/dev/how_to/adding_documentation_to_infra_resources.md index 76052bea9a..7a333fa35f 100644 --- a/docs/dev/how_to/adding_documentation_to_infra_resources.md +++ b/docs/dev/how_to/adding_documentation_to_infra_resources.md @@ -1,9 +1,9 @@ # Adding documentation to resources: -The documentation for Infra Client resources resides at [chef-wed-docs reporsitory](https://github.com/chef/chef-web-docs/). +The documentation for Infra Client resources resides at [chef-wed-docs repository](https://github.com/chef/chef-web-docs/). Currently in order to reflect the documentation added to Infra Client resources on the [website](https://docs.chef.io/) we need to follow some manual steps. # Prerequisite: -Clone [chef-wed-docs reporsitory](https://github.com/chef/chef-web-docs/). Install Hugo, npm, go. +Clone [chef-wed-docs repository](https://github.com/chef/chef-web-docs/). Install Hugo, npm, go. `brew tap go-swagger/go-swagger && brew install go-swagger hugo node go jq` @@ -17,7 +17,7 @@ The YAML files will be created under `docs_site` directory. Copy the correspondi # Generating mark down(.md) files: Go to the [chef-web-docs](https://github.com/chef/chef-web-docs/) repository, where we copied the YAML file(s). -Using the YAML file(s) create correspondown markdown(.md) file(s). +Using the YAML file(s) create corresponding markdown(.md) file(s). `hugo new -k resource content/resources/RESOURCE_NAME.md` |