From af83fa7dd6d9a5f0458169d4b6eddc6192ace088 Mon Sep 17 00:00:00 2001 From: Michael T Lombardi Date: Thu, 31 Oct 2019 13:34:26 -0500 Subject: [PATCH] (FM-8391) Update README per team practices This commit updates the readme to remove the language marking litmus as an experimental tool as well as clarifying the instructions for running acceptance tests and noting the schedule for the IA Content office hours. --- README.md | 16 ++++++++++++---- 1 file changed, 12 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index f32f553..74e6758 100644 --- a/README.md +++ b/README.md @@ -301,11 +301,19 @@ If you are adding a new source or PPA and trying to install packages from the ne Class['apt::update'] -> Package <| provider == 'apt' |> ``` - ## Development -Puppet modules on the Puppet Forge are open projects, and community contributions are essential for keeping them great. We can't access the huge number of platforms and myriad hardware, software, and deployment configurations that Puppet is intended to serve. We want to keep it as easy as possible to contribute changes so that our modules work in your environment. There are a few guidelines that we need contributors to follow so that we can have a chance of keeping on top of things. +Acceptance tests for this module leverage [puppet_litmus](https://github.com/puppetlabs/puppet_litmus). +To run the acceptance tests follow the instructions [here](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). +You can also find a tutorial and walkthrough of using Litmus and the PDK on [YouTube](https://www.youtube.com/watch?v=FYfR7ZEGHoE). -For more information, see our [module contribution guide.](https://puppet.com/docs/puppet/latest/contributing.html) +If you run into an issue with this module, or if you would like to request a feature, please [file a ticket](https://tickets.puppetlabs.com/browse/MODULES/). +Every Monday the Puppet IA Content Team has [office hours](https://puppet.com/community/office-hours) in the [Puppet Community Slack](http://slack.puppet.com/), alternating between an EMEA friendly time (1300 UTC) and an Americas friendly time (0900 Pacific, 1700 UTC). -To see who's already involved, see the [list of contributors.](https://github.com/puppetlabs/puppetlabs-apt/graphs/contributors) +If you have problems getting this module up and running, please [contact Support](http://puppetlabs.com/services/customer-support). + +If you submit a change to this module, be sure to regenerate the reference documentation as follows: + +```bash +puppet strings generate --format markdown --out REFERENCE.md +``` -- 2.45.2