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 troubleshooting information to troubleshooting page #1309

Merged
merged 6 commits into from
Oct 25, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -163,3 +163,4 @@ Please add a _short_ line describing the PR you make, if the PR implements a spe
- Return name of project creator from UserProjects ([#1303](https://github.com/ScilifelabDataCentre/dds_web/pull/1303))
- Add version to the footer of the web pages ([#1304](https://github.com/ScilifelabDataCentre/dds_web/pull/1304))
- Add link to the dds instance to the end of all emails ([#1305](https://github.com/ScilifelabDataCentre/dds_web/pull/1305))
- Troubleshooting steps added to web page ([#1309](https://github.com/ScilifelabDataCentre/dds_web/pull/1309))
31 changes: 30 additions & 1 deletion dds_web/templates/troubleshooting.html
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,37 @@
{% block body %}
<div class="container p-0" style="margin-top: 30px; font-size: medium;">
<h2>Troubleshooting the DDS</h2>
<p>The troubleshooting document provides answers to previously asked questions and possible solutions to issues that have been reported. The document can be found on GitHub or downloaded as a PDF.</p>
</br>
<h4>Experiencing issues with the DDS?</h4>
<p>Please <strong>read the troubleshooting document</strong> which provides answers to previously asked questions and possible solutions to issues that have been reported. </p>
<p>The document can be found on GitHub or downloaded as a PDF.</p>
<p class="lead"><a class="btn btn-info" href="https://github.com/ScilifelabDataCentre/dds_web/blob/master/doc/Troubleshooting.pdf" target="_blank">Read on GitHub</a>&nbsp;<a class="btn btn-info" href="https://github.com/ScilifelabDataCentre/dds_web/raw/master/doc/Troubleshooting.pdf">Download the PDF</a>&nbsp;</p>
<br>
<h4>Did the troubleshooting document not help?</h4>
<p>Please <strong>go through the following steps</strong>:</p>
<ol>
<li>If the issue is related to the CLI, <strong>verify</strong> that you have the latest version installed: Open a terminal window, run <code>dds --version</code> and compare the displayed version to the latest one. The latest version can be found at <a href="https://pypi.org/project/dds-cli/">PyPi</a>.</li>
<li><strong>Look at</strong> the CLI documentation <a href="https://scilifelabdatacentre.github.io/dds_cli/">here</a>.</li>
<li><strong>Read</strong> through the sections in the <a href="https://delivery.scilifelab.se/technical">technical overview</a> relevant to your issue and check the topics below for possible solutions.</li>
</ol>
<br>
<h4>Does the issue persist and / or the provided information not help?</h4>
<p>If you're a data producer, using the DDS for data deliveries to your users: contact the Data Centre.</p>
<p>If you're a data recipient, using the DDS to download your data from a data producing SciLifeLab unit: contact the SciLifeLab unit responsible for delivering the data to you.</p>
<p>Please <strong>provide the following information</strong>:</p>
<ul>
<li>Did the error / issue occurr in the web interface or the CLI?</li>
<li>Web:</li>
<ul>
<li>What did you attempt to do?</li>
<li>When did this message / error appear? </li>
<li>Screenshot of the web page with the error.</li>
</ul>
<li>CLI</li>
<ul>
<li>What command did you run? Please copy and paste the command so that we get the exact command.</li>
<li>Copy and paste the full output that the terminal displayed after you ran the command. </li>
</ul>
</ul>
</div>
{% endblock %}
Binary file modified doc/Troubleshooting.pdf
Binary file not shown.