chore: enhance doc-changelog migration guide #499
Merged
Conversation
This file contains 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
|
Thanks for opening a Pull Request. If you want to perform a review write a comment saying: @ansys-reviewer-bot review |
RobPasMue
reviewed
Jun 7, 2024
|
@ansys/pyansys-core do you guys prefer having a space between the steps or no space? Space: No space: |
This is related to: #499 (comment) |
SMoraisAnsys
approved these changes
Jun 7, 2024
…into maint/update-docs
RobPasMue
approved these changes
Jun 10, 2024
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.
Updated the doc-changelog migration guide to clarify setting up the release notes in the
CHANGELOG.mdfile versus the documentation (changelog.rst). Although a couple of the steps are repeated in the "release notes in your documentation" and "release notes inCHANGELOG.md" sections, I think it's clearer.Previously, you would have to set up everything for the
CHANGELOG.mdconfiguration, and then change most of what you had set up if you want to include it in your documentation instead.