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

doc: add troubleshooting section and download timeout workaround #689

Merged
merged 6 commits into from
Dec 23, 2022

Conversation

jdrueckert
Copy link
Member

Contains

  • add troubleshooting section to README.md
  • list potential download issue reasons and troubleshooting steps
  • add workaround for download timeout

How to test

  • follow the workaround steps (especially scenario 2) and check that this works

Outstanding before merging

Nothing from my side.

@jdrueckert jdrueckert added the Topic: Documentation Documentation and technical writing. label Dec 20, 2022
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated

![Download Timeout Workaround](docs/images/221220_TerasologyLauncher_download-timeout-workaround.png)
3. Rename the archive<br/>
For stable releases to `terasology-omega-<version>-stable.zip`, e.g. `terasology-omega-5.3.0-stable.zip`<br/>
Copy link
Member

Choose a reason for hiding this comment

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

I recently learned that many people actually don't know what "e.g." and "i.e." and so on are, since then I'm mostly using "for example" and "that is". I'm fine with merging, but it might happen that I'll change that at some point 😉

@skaldarnar skaldarnar merged commit 7d0d241 into master Dec 23, 2022
@skaldarnar skaldarnar deleted the doc/troubleshooting branch December 23, 2022 20:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Topic: Documentation Documentation and technical writing.
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

2 participants