Move documentation from README into the manifests

[stevenpost]

Documentation can be more easily generated using docstrings.

This was cherry-picked from @witjoh's WIP #677.

[h-haaks]

I would remove the reference section in README.md as well

[h-haaks]

@stevenpost I'm woriking on a PR to move from params to hiera.
Could you please look at my comments so that we get this merged before I change to many classes?

[stevenpost]

I would remove the reference section in README.md as well

done

[h-haaks]

Did you use the 'strings:generate:reference' rake task to update Reference.md?

[stevenpost]

Did you use the 'strings:generate:reference' rake task to update Reference.md?

I used the command puppet strings generate --format markdown instead. The rake task gives me errors, I should really look into that. I probably just need to change something on my local bundle config to include development.

[h-haaks]

The example with repo version both in readme and globals class uses 3.6.

Since 5.0 is default now and only 4.4 really is an option, should we change to 4.4 and set the title to something like
'Specify MongoDB repository version' ?

This applies to enterprise as well as community repos.

[stevenpost]

Unfortunately I'm not able to run the rake task.

$ bundle exec rake strings:generate
/home/posts/puppet/puppet-mongodb/.vendor/ruby/3.2.0/gems/io-event-1.5.1/lib/io/event/support.rb:27: warning: IO::Buffer is experimental and both the Ruby and C interface may change in the future!
[error]: Missing 'redcarpet' gem for Markdown formatting. Install it with `gem install redcarpet`

This is after running bundle install with both development and release.

From what I can tell tough, it should be fine to use a different command if the result is the same. The pipeline checks if the REFERENCE.md file is up-to-date, if not, the check fails and it won't continue with rspec of beaker tests.

PS: the module could use a modulesync, my PR on the CONTRIBUTING template got in and the old commands no longer work.

[h-haaks]

Jepp, hence my thumbs up :)

[stevenpost]

The example with repo version both in readme and globals class uses 3.6.

Since 5.0 is default now and only 4.4 really is an option, should we change to 4.4 and set the title to something like 'Specify MongoDB repository version' ?

This applies to enterprise as well as community repos.

I added a separate example for installing from enterprise, just to make it clear. Added some style fixes as well.

[h-haaks]

PS: the module could use a modulesync, my PR on the CONTRIBUTING template got in and the old commands no longer work.
Or we could just create a PR that reverts that change.

[stevenpost]

PS: the module could use a modulesync, my PR on the CONTRIBUTING template got in and the old commands no longer work. Or we could just create a PR that reverts that change.

Revert what? I'm referring to voxpupuli/modulesync_config#881

[h-haaks]

Hmm, I didn't notice, someone just stepped in two days ago and released 5.0.0 ...

[h-haaks]

PS: the module could use a modulesync, my PR on the CONTRIBUTING template got in and the old commands no longer work. Or we could just create a PR that reverts that change.

Revert what? I'm referring to voxpupuli/modulesync_config#881

Ah I see. But there is no new release of module_sync yet.
It's usually pushed to all modules when released I think.