Change filename to allow rendering on Puppet Forge. #60
Conversation
|
It is not enough to rename the file, because the syntax is not Markdown. |
… README template.
|
Oops. GitHub was doing such a good job rendering it, I didn't even notice! I updated syntax and standardized per PDK template. Still could use a 'Reference' section and some details. |
|
@dhoppe do you know what that syntax was? It was clearly another type of markup, but I did a little research and could not identify. Wondered if there might be a conversion script around... |
README.md
Outdated
| 'group:webadmin:rwx', | ||
| 'user:apache:rwx', | ||
| ], | ||
| ``` |
|
@cdchase Sorry, I have no idea which kind of syntax that is. Did you check, if this module is compatible to puppet-strings? We already have a rake task, which will generate a REFERENCE.md. |
|
I did not check anything further in this module. puppet-strings is new to me, so thanks for pointing it out. I was only intending on helping to get this visible from Puppet Forge. |
|
Fixes #55 |
Pull Request (PR) description
Rendering of README on Puppet Forge is broken due to the filename.
This PR changes the filename to match the more common use: README.md