From d9b86cd838e855720911f25ed1d909e3e5ed19aa Mon Sep 17 00:00:00 2001 From: ScriptAutomate Date: Fri, 9 Apr 2021 16:34:54 -0500 Subject: [PATCH 1/2] This didn't belong in tutorial, but README --- README.md | 20 +++++++++++++++++--- docs/gettingstarted.md | 17 ----------------- 2 files changed, 17 insertions(+), 20 deletions(-) diff --git a/README.md b/README.md index 80c458b..0c34b63 100644 --- a/README.md +++ b/README.md @@ -10,13 +10,27 @@ The provider works by generating a salt-minion config, creating pillars based on This provisioner is tested with kitchen-docker against CentOS, Ubuntu, and Debian. +## Generate and locally view docs ## + +To view the docs that were originally generated by this repository and hosted by Salt Project, the following should generate a local copy of the documentation. + + # Clear any locally generated documentation + rm -rf html/ + + # Generate HTML documentation of kitchen-salt + bundle install + bundle exec yard doc + firefox html/index.html + + # OPTIONAL + # Start a local http server to view the rendered docs + # Accessible via http://localhost:8808/ + bundle exec yard server docroot=html/ + ## Installation and Setup ## You'll need the test-kitchen and kitchen-salt gem's installed in your system, along with kitchen-vagrant or some other suitable driver for test-kitchen. Please see the [gettingstarted documentation](docs/gettingstarted.md). -To generate more detailed documentation of ruby classes, in an HTML rendered local website for viewing, -please the documentation on how to [Generate and locally view docs](docs/gettingstarted.md#generate-and-locally-view-docs). - ## Provisioner Options ## More details on all the configuration options are in the [provisioner_options documentation](docs/provisioner_options.md). diff --git a/docs/gettingstarted.md b/docs/gettingstarted.md index 1c00cad..1a40e4a 100644 --- a/docs/gettingstarted.md +++ b/docs/gettingstarted.md @@ -111,23 +111,6 @@ To specify only installing certain groups, use the `--with` and `--without` argu bundle install --with windows --without docker -## Generate and locally view docs ## - -To view the docs that were originally generated by this repository and hosted by Salt Project, the following should generate a local copy of the documentation. - - # Clear any locally generated documentation - rm -rf html/ - - # Generate HTML documentation of kitchen-salt - bundle install - bundle exec yard doc - firefox html/index.html - - # OPTIONAL - # Start a local http server to view the rendered docs - # Accessible via http://localhost:8808/ - bundle exec yard server docroot=html/ - ## Setup ## Now the `.kitchen.yml` file needs to be setup for running tests. The following sections should be copied into the {file:docs/example-kitchen.yml.md} file in the root of the directory for the `wordpress-formula` From 34cda939144fc281403225691c2cb4cabd5b00d2 Mon Sep 17 00:00:00 2001 From: ScriptAutomate Date: Fri, 9 Apr 2021 16:42:41 -0500 Subject: [PATCH 2/2] Docs for kitchen-salt --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 0c34b63..ed02b3b 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@ The provider works by generating a salt-minion config, creating pillars based on This provisioner is tested with kitchen-docker against CentOS, Ubuntu, and Debian. -## Generate and locally view docs ## +## Generate and locally view kitchen-salt docs ## To view the docs that were originally generated by this repository and hosted by Salt Project, the following should generate a local copy of the documentation.