kienan
/
puppet-strings
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

fixes for new readme edits

This commit is contained in:
jbondpdx 2018-04-11 09:15:33 -07:00
parent 11b9c81c7d
commit 0b52e521de
1 changed files with 3 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
README.md
View File

@ -66,7 +66,7 @@ To generate documentation for specific directories, run the `puppet strings gene
```
$ puppet strings generate 'modules/foo/lib/**/*.rb' 'modules/foo/manifests/**/*.pp' 'modules/foo/functions/**/*.pp' ...
```
Strings outputs documentation as HTML in a `/doc/` folder in the module.
Strings outputs documentation as HTML in a `./doc/` folder in the module.
You can serve HTML documentation locally with the `server` action. This action serves documentation for all modules in the [module path](https://docs.puppet.com/puppet/latest/reference/dirs_modulepath.html) at `http://localhost:8808`.
@ -91,7 +91,6 @@ By default, Markdown output generates a `REFERENCE.md` file, but you can specify
puppet strings generate --format markdown --out docs/INFO.md
```
Strings outputs a `REFERENCE.md` file in the main directory of the module.
### Generate documentation in JSON
@ -174,7 +173,7 @@ puppet strings generate manifest1.pp manifest2.pp
Option | Description | Values | Default
----------------|:---------------:|:------------------:|-------------------------
`--format` | Specifies a format for documentation. | Markdown, JSON | If not specified, Strings outputs HTML documentation.
`--format` | Specifies a format for documentation. | markdown, json | If not specified, Strings outputs HTML documentation.
`--out` | Specifies an output location for documentation | A valid directory location and filename. | If not specified, outputs to default locations depending on format: HTML (`/docs/`), Markdown (main module directory), or JSON (stdout).
Filenames or directory paths | Outputs documentation for only specified files or directories. | Markdown, JSON. | If not specified, Strings outputs HTML documentation.
`--verbose` | Logs verbosely. | none | If not specified, Strings logs basic information.
@ -196,7 +195,7 @@ Instead of manually writing and formatting long reference lists, add a few descr
Module READMEs are where users can learn more about what a module does and how to use it. In the module README, include basic module information and extended usage examples that address common use cases.
Complete information about classes, defined types, functions, and resource types are generated by Strings and output in HTML, Markdown, or JSON format. Strings does not yet generate information for type aliases, facts, or custom providers. If your module includes these elements, document them in your README.
Strings generates complete information about classes, defined types, functions, and resource types and providers. Strings does not yet generate information for type aliases, facts, or custom providers. If your module includes these elements, document them in your README.
The README should contain the following sections: