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 a docs section to pr template #2663

Merged
merged 2 commits into from
Jun 24, 2024
Merged

Add a docs section to pr template #2663

merged 2 commits into from
Jun 24, 2024

Conversation

EMaksy
Copy link
Member

@EMaksy EMaksy commented Jun 3, 2024

Description

This pr updates the pr template, by adding a docs section.
This change should remind every contributor about updating the documentation. Some parts of the documentation could be used in Trento's official documentation, so it is important that especially the Manual installation guide and Ansible guide is up-to-date.

Sometimes it would make sense to open a separate pr for a docs update, in this case it would not harm to add a reference in the pr description.
If docs do not require an update, a simple no docs update required would be more than enough, similar like what we write in the "How was this tested" section

How was this tested?

No tests needed

@EMaksy EMaksy added documentation Improvements or additions to documentation enhancement New feature or request labels Jun 3, 2024
@EMaksy EMaksy self-assigned this Jun 3, 2024
@EMaksy EMaksy marked this pull request as ready for review June 3, 2024 13:58
Copy link
Member

@nelsonkopliku nelsonkopliku left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @EMaksy thanks for this!

I am fine eitherway with the list of links ore just the reminder.
If you wanna keep the list of links maybe we could compact web related links to a generic https://github.com/trento-project/web/blob/main/guides/

Copy link
Contributor

@rtorrero rtorrero left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @EMaksy! LGTM

Copy link
Member

@stefanotorresi stefanotorresi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The problem with adding links is that our documentation is a bit scattered at the moment, so there is no single place one should look into. Certainly it's not just the installation docs, so if you decide to keep it you need to make it more generic.

Copy link
Member

@janvhs janvhs left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just have some minor changes in writing, but that's 100% optional and it LGTM :D

.github/pull_request_template.md Outdated Show resolved Hide resolved
.github/pull_request_template.md Outdated Show resolved Hide resolved
.github/pull_request_template.md Outdated Show resolved Hide resolved
.github/pull_request_template.md Outdated Show resolved Hide resolved
.github/pull_request_template.md Outdated Show resolved Hide resolved
@EMaksy
Copy link
Member Author

EMaksy commented Jun 5, 2024

Thanks for the feedback!

I refactored the pr a bit and added a Done section, as an inspiration from the uyuni project.

What I liked about it, it adds a clickable task list with progress see Github: About task lists.
It is fully optional, and everybody can delete the template, but it provides a nice visual touch.

Copy link
Contributor

@gagandeepb gagandeepb left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe a consideration for later, but would (optionally, perhaps) putting/linking ticket numbers in PRs be interesting?

@EMaksy EMaksy force-pushed the update_pr_request_template branch from 23c9781 to 9bed0cd Compare June 24, 2024 09:20
@EMaksy EMaksy merged commit df11f76 into main Jun 24, 2024
26 checks passed
@EMaksy EMaksy deleted the update_pr_request_template branch June 24, 2024 09:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Development

Successfully merging this pull request may close these issues.

8 participants