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

Update the steps to generate a log file in freezing-behavior.md #1241

Merged
merged 5 commits into from
Jul 9, 2024
Merged

Update the steps to generate a log file in freezing-behavior.md #1241

merged 5 commits into from
Jul 9, 2024

Conversation

ws909
Copy link
Contributor

@ws909 ws909 commented Jul 6, 2024

The existing explanation was for a previous version of the system.

The existing explanation was for a previous version of the system.
@leviport leviport requested a review from a team July 8, 2024 13:49
Copy link
Member

@ahoneybun ahoneybun left a comment

Choose a reason for hiding this comment

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

I think we should have both and just update the steps for the driver since it also applies to system76 systems.

@ws909
Copy link
Contributor Author

ws909 commented Jul 8, 2024

Do you mean that the old explanation should be kept there? It's already listed on the page linked to at the end. It was moved to the Settings application a few OS versions ago now.

I have not checked if other help pages also have this outdated explanation; if changes are made, they should probably be made for every help page.

@ahoneybun
Copy link
Member

Do you mean that the old explanation should be kept there? It's already listed on the page linked to at the end. It was moved to the Settings application a few OS versions ago now.

I have not checked if other help pages also have this outdated explanation; if changes are made, they should probably be made for every help page.

No it is in both the Settings (only on Pop!_OS) and in the System76 Driver for both Ubuntu and Pop!_OS.

@ws909
Copy link
Contributor Author

ws909 commented Jul 8, 2024

Is it better to just remove the detailed explanation from the page, then, and rely on the link? For instance,

Please attach a log file in a reply to this ticket. For a detailed list of steps to generate a log file, or if you are having any issues, you can refer to this article.

In all fairness, I do find it a bit strange that this section exists in the first place. I haven't made any contributions here before, so my opinion certainly doesn't carry a lot of weight. I did however find the section quite out of place when I read it. I was looking through a few troubleshooting pages, and it was the first time1 I heard anything of support tickets. I was not aware of this option, and when looking at the site again, it did not seem to be readily available anywhere (eventually found a link buried in here). It would be a reasonable section to include if it was sent by a support agent as a response to an already opened ticket, but it was out of place when looking at that page outside of that context. Other similar troubleshooting pages do not have this section.

Footnotes

  1. Actually, I see now that the top of the page has "If you have a support ticket open"; I was still a bit confused at the at the section. I may have missed this note while looking through the page and scrolling down.

Readd the log file creation in the System76 Driver in addition to in the Settings application
@ws909 ws909 requested a review from ahoneybun July 8, 2024 21:26
@ahoneybun
Copy link
Member

Is it better to just remove the detailed explanation from the page, then, and rely on the link? For instance,

Please attach a log file in a reply to this ticket. For a detailed list of steps to generate a log file, or if you are having any issues, you can refer to this article.

In all fairness, I do find it a bit strange that this section exists in the first place. I haven't made any contributions here before, so my opinion certainly doesn't carry a lot of weight. I did however find the section quite out of place when I read it. I was looking through a few troubleshooting pages, and it was the first time1 I heard anything of support tickets. I was not aware of this option, and when looking at the site again, it did not seem to be readily available anywhere (eventually found a link buried in here). It would be a reasonable section to include if it was sent by a support agent as a response to an already opened ticket, but it was out of place when looking at that page outside of that context. Other similar troubleshooting pages do not have this section.

Footnotes

1. Actually, I see now that the top of the page has "If you have a support ticket open"; I was still a bit confused at the at the section. I may have missed this note while looking through the page and scrolling down. [↩](#user-content-fnref-1-e16d9e7dfd9b32ddfd7136a699fb71fe)

That is for customers who have system76 hardware since they would send the logs to one of the support folks such as myself.

ahoneybun
ahoneybun previously approved these changes Jul 9, 2024
Copy link
Member

@ahoneybun ahoneybun left a comment

Choose a reason for hiding this comment

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

I believe this should be good now.

Copy link
Member

@leviport leviport left a comment

Choose a reason for hiding this comment

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

@ahoneybun can you fix that lint issue? Other than that, this looks good.

Copy link
Member

@leviport leviport left a comment

Choose a reason for hiding this comment

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

Thanks!

@leviport leviport requested a review from ahoneybun July 9, 2024 13:11
@ahoneybun ahoneybun merged commit aa479d4 into system76:master Jul 9, 2024
3 checks passed
@ws909 ws909 deleted the patch-1 branch July 9, 2024 13:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants