From 852b6d2a19654a954f39d06689d7af975c02a079 Mon Sep 17 00:00:00 2001
From: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com>
Date: Sun, 19 Nov 2023 07:20:22 +0100
Subject: [PATCH] docs(puppet manager): rewrite (#25819)

---
 lib/modules/manager/puppet/readme.md | 103 ++++++++++++---------------
 1 file changed, 46 insertions(+), 57 deletions(-)

diff --git a/lib/modules/manager/puppet/readme.md b/lib/modules/manager/puppet/readme.md
index 7656583efeda8c..1aa0a511ca85d4 100644
--- a/lib/modules/manager/puppet/readme.md
+++ b/lib/modules/manager/puppet/readme.md
@@ -1,85 +1,74 @@
-simply keeps Puppetfiles updated
+Renovate can update Puppetfiles.
 
-### How It Works
+### How it works
 
-1. Renovate searches in each repository for any `Puppetfile` files
-1. Existing dependencies are extracted from the relevant sections of the file
-1. Renovate resolves the dependency on the provided forges (or uses `https://forgeapi.puppetlabs.com` as default)
-1. A PR is created with `Puppetfile` updated in the same commit
-1. If the source repository has either a "changelog" file or uses GitHub releases, then Release Notes for each version will be embedded in the generated PR
+Renovate:
 
-### supported Puppetfile formats
+1. Searches each repository for any `Puppetfile` files
+1. Extracts dependencies from the relevant sections of the `Puppetfile`
+1. Resolves the dependency on the default forge: `https://forgeapi.puppetlabs.com`, or on a user-defined forge
+1. Creates a PR that updates the `Puppetfile`
 
-the manager extracts the deps from one Puppetfile
+Finally, if the source repository has a "changelog" file _or_ uses GitHub releases, then Renovate puts the changelogs for each version in its PR.
 
-the Puppetfile supports at the moment different ways to configure forges
+### Supported Puppetfile formats
 
-1. no forge defined
+The `puppet` manager extracts the dependencies from one Puppetfile.
+You can define a forge in your `puppetfile` in these ways:
 
-   ```ruby
-   mod 'puppetlabs/apt', '8.3.0'
-   mod 'puppetlabs/apache', '7.0.0'
-   ```
+- No forge
+- One forge
+- Multiple forges
+- GitHub-based forge
+- Git-based forge
 
-2. one forge defined: `forge "https://forgeapi.puppetlabs.com"`
+For example:
 
-   ```ruby
-   forge "https://forgeapi.puppetlabs.com"
-
-   mod 'puppetlabs/apt', '8.3.0'
-   mod 'puppetlabs/apache', '7.0.0'
-   mod 'puppetlabs/concat', '7.1.1'
-   ```
-
-3. multiple forges defined
+```ruby title="No forge"
+mod 'puppetlabs/apt', '8.3.0'
+mod 'puppetlabs/apache', '7.0.0'
+```
 
-   ```ruby
-   forge "https://forgeapi.puppetlabs.com"
+```ruby title="One forge"
+forge "https://forgeapi.puppetlabs.com"
 
-   mod 'puppetlabs/apt', '8.3.0'
-   mod 'puppetlabs/apache', '7.0.0'
-   mod 'puppetlabs/concat', '7.1.1'
+mod 'puppetlabs/apt', '8.3.0'
+mod 'puppetlabs/apache', '7.0.0'
+mod 'puppetlabs/concat', '7.1.1'
+```
 
-   # private forge
-   forge "https://forgeapi.example.com"
+```ruby title="Multiple forges"
+forge "https://forgeapi.puppetlabs.com"
 
-   mod 'example/infra', '3.3.0'
-   ```
+mod 'puppetlabs/apt', '8.3.0'
+mod 'puppetlabs/apache', '7.0.0'
+mod 'puppetlabs/concat', '7.1.1'
 
-4. github based version
+# Private forge
+forge "https://forgeapi.example.com"
 
-   ```ruby
-   # tag based
-   mod 'example/standalone_jar',
-      :git => 'git@gitlab.example.de:puppet/example-standalone_jar',
-      :tag => '0.9.0'
-   ```
+mod 'example/infra', '3.3.0'
+```
 
-5. git based version
+```ruby title="GitHub-based forge, tag based"
+mod 'example/standalone_jar',
+    :git => 'git@gitlab.example.de:puppet/example-standalone_jar',
+    :tag => '0.9.0'
+```
 
-   ```ruby
-   # tag based
-   mod 'stdlib',
+```ruby title="Git-based forge, tag based"
+mod 'stdlib',
     :git => 'git@gitlab.com:example/project_stdlib.git',
     :tag => '5.0.0'
-   ```
-
-### possible improvements
-
-#### further git-support
-
-usually you can add the versions to a forge and use the already provided
-way of updating
+```
 
-```ruby
-# branch based
+```ruby title="Git-based forge, branch based"
 mod 'example/samba',
     :git    => 'https://github.com/example/puppet-samba',
     :branch => 'stable_version'
 ```
 
-```ruby
-# ref based
+```ruby title="Git-based forge, ref based"
 mod 'example/samba',
     :git => 'https://github.com/example/puppet-samba',
     :ref => 'stable_version'