Skip to content
This repository has been archived by the owner on Mar 29, 2024. It is now read-only.

Added troubleshooting section for download #75

Merged
merged 7 commits into from
Nov 4, 2023
Merged

Added troubleshooting section for download #75

merged 7 commits into from
Nov 4, 2023

Conversation

filopedraz
Copy link
Contributor

@filopedraz filopedraz commented Oct 27, 2023 •
edited
Loading

Description

@filopedraz filopedraz requested a review from tiero October 27, 2023 06:49
@what-the-diff
Copy link

what-the-diff bot commented Oct 27, 2023

PR Summary

  • Introduction of New Troubleshooting Section
    A new troubleshooting guide section has been added to the Premium App documentation. This will be particularly helpful in foreseeing and solving common issues the users might face, thereby improving user experience and satisfaction.

  • Inclusion of Service Download Hanging Guide
    Introduction of a new document that will serve as a guide with instructions to resolve instances where service download is hanging. This will reduce service downtime and improve service usability.

  • New Troubleshooting Illustration
    A new visual aid (troubleshooting.png) has been included to make the troubleshooting guidelines more understandable, aiding in faster and more effective problem-solving.

  • Adjustment of Documentation Structure
    To facilitate better navigation and hierarchy, the position of Usage in the Premium App documentation category has been changed from 2 to 3. This restructuring will enhance the readability and ease of access of the documentation.

tiero
tiero reviewed Oct 27, 2023
View reviewed changes
docs/prem-app/troubleshooting/service-download-hanging.md
sidebar_position: 1
---

# Service Download Hanging
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
# Service Download Hanging
# Prem Server
## Service Download Hanging

Copy link
Contributor Author

Choose a reason for hiding this comment

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

If we accept these changes, then we need to rename the file too.

Copy link
Contributor

Choose a reason for hiding this comment

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

The idea is to have one sidebar element for each issue or one page for all?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I was thinking of one sidebar element for each issue. Easier to read and find. What do you think?

nsosio
nsosio reviewed Nov 4, 2023
View reviewed changes
docs/prem-app/network-mode.md

![Network Install](./assets/network-install.png)

When the process is completed, a pop-up will appear with the following message:
Copy link
Contributor

Choose a reason for hiding this comment

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

actually when the pop-up appears it still needs to install requirements the first time (see this

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Should we specify this? I am not sure.

Copy link
Contributor

Choose a reason for hiding this comment

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

Yes maybe it's too much and not necessary

docs/prem-app/network-mode.md
Copy link
Contributor

Choose a reason for hiding this comment

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

Is it worth to mention that the environment can be cleaned up with the delete button?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Good point, but the delete button is not there anymore. Commit has been probably lost in a rebase.

Copy link
Contributor

Choose a reason for hiding this comment

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

I've checked it again today with @tiero and it's there 🤔

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Updated the documentation

@tiero tiero merged commit dce6e26 into premAI-io:main Nov 4, 2023
1 check passed
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@tiero tiero tiero left review comments

@nsosio nsosio nsosio left review comments

@casperdcl casperdcl Awaiting requested review from casperdcl

@biswaroop1547 biswaroop1547 Awaiting requested review from biswaroop1547

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Add Contribute GPU Guide for Prem App Swarm Mode Add troubleshooting for Service Download
3 participants
@filopedraz @tiero @nsosio