Skip to content

Commit f898c38

Browse files
authored
Merge pull request #330 from puppetlabs/maint-readme_cleanup
(MAINT) Clean up README.md
2 parents 3f6165c + 5b925a4 commit f898c38

File tree

1 file changed

+2
-8
lines changed

1 file changed

+2
-8
lines changed

README.md

+2-8
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Strings processes code and YARD-style code comments to create documentation in H
99

1010
### Requirements
1111

12-
* Ruby 2.5.0 or newer
12+
* Ruby 2.7.0 or newer
1313
* Puppet 6.0.0 or newer
1414

1515
### Install Puppet Strings
@@ -57,7 +57,7 @@ Markdown output is written to a REFERENCE.md file in the module's main directory
5757

5858
See the [Puppet Strings documentation](https://puppet.com/docs/puppet/latest/puppet_strings.html) for complete instructions for generating documentation with Strings.
5959

60-
For code comment style guidelines and examples, see the [Puppet Strings style guide](https://puppet.com/docs/puppet/5.5/puppet_strings_style.html).
60+
For code comment style guidelines and examples, see the [Puppet Strings style guide](https://puppet.com/docs/puppet/latest/puppet_strings_style.html).
6161

6262
### Additional Resources
6363

@@ -124,17 +124,11 @@ An example of running the acceptance tests locally with Docker:
124124
bundle exec rake litmus:tear_down
125125
```
126126

127-
The [Litmus Wiki](https://github.com/puppetlabs/puppet_litmus/wiki) contains more indepth information about Litmus.
128-
129-
There is also a tutorial on using Litmus with an example [Puppet Module](https://github.com/puppetlabs/puppet_litmus/wiki/Tutorial:-use-Litmus-to-execute-acceptance-tests-with-a-sample-module-(MoTD)#install-the-necessary-gems-for-the-module)
130-
131127
## Support
132128

133129
Please log issues in [GitHub issues](https://github.com/puppetlabs/puppet-strings/issues).
134130
Check out [CONTRIBUTING.md](https://github.com/puppetlabs/puppet-strings/blob/main/CONTRIBUTING.md) for tips on writing _the best_ issues.
135131

136-
A [mailing list](https://groups.google.com/forum/?fromgroups#!forum/puppet-users) is available for asking questions and getting help from others.
137-
138132
There is also an active community on the [Puppet community Slack](https://slack.puppet.com) in the #forge-modules channel.
139133

140134
We use semantic version numbers for our releases and recommend that users upgrade to patch releases and minor releases as they become available.

0 commit comments

Comments
 (0)