-
Notifications
You must be signed in to change notification settings - Fork 123
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add documention best practices, adjust release notes #3007
Merged
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
happz
added
documentation
Improvements or additions to documentation
code | no functional change
"No Functional Change" intended. Patch should not change tmt's behavior in any way.
code | trivial
A simple patch - a couple of lines, an easy-to-understand change, a typo fix.
labels
Jun 12, 2024
happz
requested review from
psss,
lukaszachy,
thrix and
janhavlin
as code owners
June 12, 2024 13:28
therazix
reviewed
Jun 13, 2024
lukaszachy
reviewed
Jul 16, 2024
falconizmi
reviewed
Jul 16, 2024
martinhoyer
reviewed
Jul 16, 2024
happz
force-pushed
the
docs-release-notes-point-to-plugins
branch
from
July 16, 2024 12:33
5156241
to
477d592
Compare
martinhoyer
approved these changes
Jul 16, 2024
falconizmi
approved these changes
Jul 16, 2024
happz
force-pushed
the
docs-release-notes-point-to-plugins
branch
from
July 17, 2024 13:09
477d592
to
69bc890
Compare
therazix
reviewed
Jul 17, 2024
psss
approved these changes
Jul 19, 2024
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Very nice documentation hints! Thanks for putting this together.
Co-authored-by: Filip Vágner <fvagner@redhat.com>
Co-authored-by: Filip Vágner <fvagner@redhat.com>
psss
force-pushed
the
docs-release-notes-point-to-plugins
branch
from
July 19, 2024 08:05
89f2d46
to
88b6434
Compare
I think it's worth to mention the new docs best practices in the release notes as well, done in 88b6434. |
psss
changed the title
In Releases page, point to plugin docs when mentioning a plugin
Add documention best practices, adjust release notes
Jul 19, 2024
The-Mule
pushed a commit
to The-Mule/tmt
that referenced
this pull request
Oct 14, 2024
* Add a new set of documentation best practices * In Releases page, point to plugin docs when mentioning a plugin Co-authored-by: Filip Vágner <fvagner@redhat.com> Co-authored-by: Petr Šplíchal <psplicha@redhat.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
code | no functional change
"No Functional Change" intended. Patch should not change tmt's behavior in any way.
code | trivial
A simple patch - a couple of lines, an easy-to-understand change, a typo fix.
documentation
Improvements or additions to documentation
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.
Pull Request Checklist