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

Extend troubleshooting guide according to findings during matrix support chat #283

Merged
merged 20 commits into from
Mar 13, 2023

Conversation

eLtMosen
Copy link
Member

There have been multiple instances now where users came into chat and asked for help with a bootloop. Many of them under impression they might have bricked their devices.

I take this as a sign that our current install troubleshoot might profit from some refinement. Especially since the keyword "Bootloop" is not even used as a topic heading currently.

This PR tries to better reassure users and guide them to the appropriate solution steps much more detailed than before.

  • Divided guide into boot and flashing problems. Boot problems first due to higher severity.
  • Reordered use of h2, h3 and h4 to better integrate h4 into the new lists.
  • Heavily extended all parts according to findings made during support chat on matrix.

grafik
grafik
grafik

Copy link
Contributor

@dodoradio dodoradio left a comment

Choose a reason for hiding this comment

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

I've been nitpicky about some small grammar things, but also about some larger presentation things, I hope this is appreciated. There are a few more grammar bugs I've noticed, but I'll pick these out once a few more people give their opinions on the overall text.

templates/includes/install-problems.hbs Outdated Show resolved Hide resolved
templates/includes/install-problems.hbs Outdated Show resolved Hide resolved
templates/includes/install-problems.hbs Outdated Show resolved Hide resolved
templates/includes/install-problems.hbs Outdated Show resolved Hide resolved
templates/includes/install-problems.hbs Outdated Show resolved Hide resolved
templates/includes/install-problems.hbs Outdated Show resolved Hide resolved
templates/includes/install-problems.hbs Outdated Show resolved Hide resolved
@eLtMosen
Copy link
Member Author

Thank you very much for the review @dodoradio
I have addressed all of your suggestions and resolved the obvious conversations. Left the two with multiple options unresolved for others to chime in.

Copy link
Member

@beroset beroset left a comment

Choose a reason for hiding this comment

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

Good contribution! Thanks.

templates/includes/install-problems.hbs Outdated Show resolved Hide resolved
@eLtMosen eLtMosen force-pushed the refine-install-troubleshoot branch from e07f267 to a132b69 Compare March 12, 2023 13:47
Copy link
Member

@MagneFire MagneFire left a comment

Choose a reason for hiding this comment

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

Again, great work!

Just some minor enhancement suggestions from my side, otherwise looking good to me.

<li><h4>Verify that you used the correct image files</h4>Some devices like the Asus Zenwatch 2, the Fossil Gen4 models and the MTK6580 watches have more than one system image supplied, for different variants with slightly different hardware. Most watches have a graphical fastboot menu that shows the correct codename for the watch. Others need to be identified using the hardware differences noted above in the install section.</li>
<li><h4>Clean your watch and charger contacts</h4>Even in case the fastboot flash process succeeds with no errors, it can still silently fail due to connection problems caused by dirty contacts. Clean the pins and pads with isopropyl alcohol. Ideally using that old toothbrush you keep around for electronics cleaning or a microfiber cloth. Carefully sanding the contacts (e.g. with a nailfile) can help in case of obvious corrosion.</li>
<li><h4>Ensure a stable USB connection</h4>Put the watch and your computer on the same flat surface. Try to not move the cable connecting your computer and the watch during the whole flashing process. In case of worn or corroded contacts and pogo-pins that lost their springiness, it might be useful to attach the watch to its cradle or charging cable using duct tape or rubber bands.</li>
<li><h4>Repeat the flash process.</h4>Some users have reported needing up to five flashing attempts for a successful result.<br>There is a small chance that the image files were corrupted during download. We do not currently provide checksums for the files. However, if you download the files again under a different filename and then compare them with <code>sha256sum filename</code>, the checksums must match.</li>
Copy link
Member

Choose a reason for hiding this comment

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

Great idea! This makes me wonder if we should provide the sha256sum information on the install pages themselves too since we already know the checksums in advance: https://release.asteroidos.org/nightlies/beluga/MD5SUMS

(This also means that the We do not currently provide checksums for the files. claim, is incorrect 😉 )

Copy link
Member Author

@eLtMosen eLtMosen Mar 12, 2023

Choose a reason for hiding this comment

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

That is a great surprise! Coool, i thought it would be complicated to add checksums so did not ask but came up with the re-download work around.
Let's keep the We do not currently... sentence until the checksums are actually shown on the website?
Making a new issue for that:
#284

templates/includes/install-problems.hbs Outdated Show resolved Hide resolved
templates/includes/install-problems.hbs Outdated Show resolved Hide resolved
templates/includes/install-problems.hbs Outdated Show resolved Hide resolved
Copy link
Member

@FlorentRevest FlorentRevest left a comment

Choose a reason for hiding this comment

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

This is so cool ! Thank you so much @eLtMosen and everybody who contributed to the reviews :D Our users will be very thankful

@FlorentRevest FlorentRevest merged commit a7d0903 into AsteroidOS:master Mar 13, 2023
@FlorentRevest
Copy link
Member

Oops, I should have squashed that git log but was too excited to merge it... Weellll.... now it's there uh

@eLtMosen eLtMosen deleted the refine-install-troubleshoot branch March 16, 2023 13:45
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.

None yet

5 participants