diff options
| author | Neha Pansare <neha.pansare@progress.com> | 2022-07-04 17:43:28 +0530 |
|---|---|---|
| committer | Neha Pansare <neha.pansare@progress.com> | 2022-07-04 17:43:28 +0530 |
| commit | fb016af5f4843cc0e44ca37abf13e29cd0659674 (patch) | |
| tree | 86a22c09870ce06786e33a29eb94616e397c553f | |
| parent | eca272d679b7cd0c5b155c641945e1c852776e28 (diff) | |
| download | chef-fb016af5f4843cc0e44ca37abf13e29cd0659674.tar.gz | |
Add how to doc with details about documentation for infra client resources
Signed-off-by: Neha Pansare <neha.pansare@progress.com>
| -rw-r--r-- | docs/dev/how_to/adding_documentation_to_infra_resources.md | 29 |
1 files changed, 29 insertions, 0 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 new file mode 100644 index 0000000000..76052bea9a --- /dev/null +++ b/docs/dev/how_to/adding_documentation_to_infra_resources.md @@ -0,0 +1,29 @@ +# Adding documentation to resources: +The documentation for Infra Client resources resides at [chef-wed-docs reporsitory](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. + +`brew tap go-swagger/go-swagger && brew install go-swagger hugo node go jq` + +# Generating YAML files: +The YAML data is generated using a [rake](https://github.com/chef/chef/blob/main/tasks/docs.rb) task in the `chef/chef` repository. + +`rake docs_site:resources` + +The YAML files will be created under `docs_site` directory. Copy the corresponding file(s) for the resource(s) for which documentation is updated to [chef-web-docs/data/infra/resources](https://github.com/chef/chef-web-docs/tree/main/data/infra/resources). +(NOTE: The data file(.yaml) should be verified and edited manually to remove any inaccuracies.) + +# 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). + +`hugo new -k resource content/resources/RESOURCE_NAME.md` + +# Verifying changes locally: +Run server locally and verify the changes in your browser at http://localhost:1313 + +`make serve` + +Once changes are verified, create a PR at [chef-web-docs](https://github.com/chef/chef-web-docs/) repository.
\ No newline at end of file |