Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Sensu2 docs #932

Merged
merged 1 commit into from
Jul 30, 2018
Merged

Sensu2 docs #932

merged 1 commit into from
Jul 30, 2018

Conversation

treydock
Copy link
Collaborator

Pull Request Checklist

Description

Documentation improvements.

Related Issue

Relates to #901

Motivation and Context

Wanted to provide some better examples for classes as well as types that have complex properties or composite name support. Also removed defaults from puppet-strings inline documentation as puppet-strings will read defaults from module code and wanted to remove duplicate default output.

How Has This Been Tested?

bundle exec rake strings:generate

General

  • New parameters are documented

  • New parameters have tests

  • Tests pass - bundle exec rake validate lint spec

@treydock treydock force-pushed the sensu2-docs branch 2 times, most recently from 765b24b to 761f589 Compare July 5, 2018 23:42
@treydock
Copy link
Collaborator Author

@ghoneycutt Let me know if squash is necessary. #944 needed for tests to pass.

@ghoneycutt
Copy link
Collaborator

@treydock #944 is merged, please rebase and squash

* Add some additional examples
* Use consistent puppet-strings doc format
* Remove defaults as puppet-strings will show defaults

Cleanup commented code
@treydock
Copy link
Collaborator Author

@ghoneycutt squashed and rebased.

@ghoneycutt ghoneycutt merged commit c330c51 into sensu:sensu2 Jul 30, 2018
@treydock treydock deleted the sensu2-docs branch July 31, 2018 22:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants