Update contributing docs to include updates to mkdocs.yml file #99
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
whitej6
previously approved these changes
Mar 9, 2024
whitej6
previously approved these changes
Mar 9, 2024
glennmatthews
approved these changes
May 8, 2024
| - Update the release notes in `docs/admin/release_notes/version_<major>.<minor>.md` file to reflect the changes. | ||
| - You can run `invoke generate-release-notes` to generate these notes and delete the legacy towncrier fragments. | ||
| - Please consider adding changelog's from ltm releases in current release, as applicable. | ||
| - Update the mkdocs.yml file to include the reference to `docs/admin/release_notes/version_<major>.<minor>.md` as applicable. | ||
| - Change the version from `<major>.<minor>.<patch>-beta` to `<major>.<minor>.<patch>` in `pyproject.toml`. |
There was a problem hiding this comment.
Best way to do this is poetry version <major>.<minor>.<patch> rather than manually editing pyproject.toml. Same comment on line 70/76 below.
There was a problem hiding this comment.
(or to just bump it to the next release version, poetry version patch or poetry version minor as appropriate).
|
This section of |
|
Forgot to say I'll take a look at the proposed changes here and include them if need be. |
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.
Closes N/A
What's Changed
doc updates
To Do
N/A