Alexharvey/clean up docs #11
Conversation
Clean up the Markdown formatting. Some slightly better examples. Also, remove unnecessary instruction to include wait_for. That is not required to make a custom type available. Add a section on testing. Some minor changes to comments in the code.
This should make it easier to release a new version.
|
After this, would it be possible to release a new version on the forge, or does @basti1302 need to do that? |
There was a problem hiding this comment.
I think @basti1302 doesn't really care anymore, so you might want to s/basti1302/heini/g. I'll then take care to make a new release under that name.
Changing project URL and documentation to indicate that Dirk Heinrichs is the new maintainer of the project. Bump major version due to rewrite.
|
Ok updated. I bumped the major version to 2.0.0 based on the rewrite, whereas bumping it to 1.0.0 didn't feel right. Also, I made some simple notes on how to use Blacksmith to push to forge at this other project I maintain. https://github.com/alexharv074/puppet-firewall_multi |
|
For the record, if there is anything you need my help with for publishing a new release, I can do that. But as @heini said, I've not used Puppet in years, so just publishing under a new account name is probably a good idea. If you want to and if it helps, we can release a final version under my basti1302 Puppet Forge account with a deprecation notice that links to the new Puppet Forge project/url, so that existing users find the new home of this project more easily (if that is even necessary, I don't know). |
|
Sorry for replying late. @basti1302, that would be a good idea, I think. |
|
Can you prepare a branch with the content you want to be published under my forge account? I'll do the publish from that branch then. |
|
@basti1302 , @heini I checked with the Puppet community. Apparently, the process for deprecating at the Forge would be:
|
|
@heini Considering the above, I think we could just merge this now? |
|
@basti1302 , ignore the above. Apparently, we just need to raise a ticket in the Jira and Puppet will deprecate the module in the backend. I'll do that. No need to anything here. @heini however I guess you should release this first in your username ? |
|
@alexharv074 Thanks for figuring out the process. I'll just comply with your request and do nothing then. It's something I excel at ;-) |
|
Deprecation ticket in Jira raised here https://tickets.puppetlabs.com/browse/MODULES-7464 |
|
Ah, yes. Thanks a lot. I thought there was still one step missing but I couldn't remember what it was... |
Add the Puppet-blacksmith Gem
This should make it easier to release a new version.
Clean up README.md
Clean up the Markdown formatting. Some slightly better examples. Also,
remove unnecessary instruction to include wait_for. That is not required
to make a custom type available. Add a section on testing.
Some minor changes to comments in the code.