Skip to content
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 6 commits into from
Jul 19, 2024

Conversation

happz
Copy link
Collaborator

@happz happz commented Jun 12, 2024

Pull Request Checklist

  • implement the feature
  • write the documentation
  • include a release note

@happz 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 happz added this to the 1.35 milestone Jun 12, 2024
docs/contribute.rst Outdated Show resolved Hide resolved
docs/contribute.rst Outdated Show resolved Hide resolved
docs/contribute.rst Outdated Show resolved Hide resolved
docs/contribute.rst Show resolved Hide resolved
docs/releases.rst Show resolved Hide resolved
@happz happz force-pushed the docs-release-notes-point-to-plugins branch from 5156241 to 477d592 Compare July 16, 2024 12:33
@happz happz force-pushed the docs-release-notes-point-to-plugins branch from 477d592 to 69bc890 Compare July 17, 2024 13:09
docs/contribute.rst Outdated Show resolved Hide resolved
Copy link
Collaborator

@psss psss left a 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.

@psss psss force-pushed the docs-release-notes-point-to-plugins branch from 89f2d46 to 88b6434 Compare July 19, 2024 08:05
@psss psss self-assigned this Jul 19, 2024
@psss
Copy link
Collaborator

psss commented Jul 19, 2024

I think it's worth to mention the new docs best practices in the release notes as well, done in 88b6434.

@psss 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
@psss psss requested review from therazix and lukaszachy July 19, 2024 08:08
@psss psss merged commit e75a49e into main Jul 19, 2024
9 of 19 checks passed
@psss psss deleted the docs-release-notes-point-to-plugins branch July 19, 2024 08:24
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants