docs: Add README section on how to create releases#92
Merged
justinmayer merged 2 commits intomainfrom Mar 17, 2025
Merged
Conversation
justinmayer
approved these changes
Mar 17, 2025
Contributor
justinmayer
left a comment
There was a problem hiding this comment.
Many thanks for the documentation enhancement, @minchinweb. I made a few minor tweaks.
Traditionally the idea has been to keep things DRY by documenting this process in Pelican's Contributing and Feedback Guidelines documentation, but until that documentation can be expanded to better describe the release process and release file format, I think this is an excellent addition to this plugin's documentation 👍
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds a section to the Readme about how to use the
RELEASE.mdfile and encouraging it's use.