Skip to content

Fix example docs #499

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

Merged
merged 1 commit into from
Jun 5, 2014
Merged

Fix example docs #499

merged 1 commit into from
Jun 5, 2014

Conversation

digitalyuki
Copy link
Contributor

  • Edited the examples of resource hashes to be what would actually be used (while it's defined as hash like "$example = { stuff => 'it'}" in the module itself, in actual use when included it works like an attribute, i.e. "example => { stuff => 'it' }" ).
  • Removed the 'puppet' markdown, as markdown then colored the hashed attributes as not being correct, which is probably why it was shown the way it was in the first place.

@igalic
Copy link
Contributor

igalic commented Apr 21, 2014

I think the idea for this is something like:

$foo = {
  blah = 'blub',
}
type { 'x':
  foo => $foo,
}

@digitalyuki
Copy link
Contributor Author

There is no explicit example such as what you provide above, I would be satisfied if the example were:

class { '::mysql::server':
  root_password    => 'strongpassword',
  override_options => $override_options
}

and then have:

The hash structure for overrides in mysql::server is as follows:

$override_options = {
  'section' => {
    'item'             => 'thing',
  }
}

@igalic
Copy link
Contributor

igalic commented Apr 22, 2014

+1

1 similar comment
@blkperl
Copy link
Contributor

blkperl commented May 23, 2014

+1

@blkperl
Copy link
Contributor

blkperl commented May 23, 2014

Please squash the commits into one commit and then force push to update this PR.

@igalic
Copy link
Contributor

igalic commented Jun 4, 2014

ping @digitalyuki can you please squash your commits?

…rameters

Edited the puppet markup

Made changes as suggested, with one-liner comment added to refer to Overrides for examples of the hash structure
@digitalyuki
Copy link
Contributor Author

Squashed.

igalic added a commit that referenced this pull request Jun 5, 2014
@igalic igalic merged commit 357ad76 into puppetlabs:master Jun 5, 2014
@igalic
Copy link
Contributor

igalic commented Jun 5, 2014

merged

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants