You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@airavata.apache.org by er...@apache.org on 2022/07/08 06:59:42 UTC
[airavata-user-docs] branch main updated: Updating the Airavata user docs with instructions for users.
This is an automated email from the ASF dual-hosted git repository.
eroma pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/airavata-user-docs.git
The following commit(s) were added to refs/heads/main by this push:
new b69fe7d Updating the Airavata user docs with instructions for users.
b69fe7d is described below
commit b69fe7d02f4c987fab680bc84b93a96c7a3cbce9
Author: eroma2014 <er...@gmail.com>
AuthorDate: Fri Jul 8 02:59:34 2022 -0400
Updating the Airavata user docs with instructions for users.
---
docs/img/fetchfiles.png | Bin 0 -> 267495 bytes
docs/img/managestorage.png | Bin 0 -> 161402 bytes
docs/img/sshkeygen.png | Bin 0 -> 83997 bytes
docs/img/usersettings.png | Bin 0 -> 126692 bytes
docs/user-documentation/monitor-experiment.md | 9 +++--
docs/user-documentation/other-features.md | 47 +++++++++++++++++++++++---
docs/user-documentation/quick-start.md | 1 +
docs/user-documentation/tutorial.md | 2 +-
8 files changed, 51 insertions(+), 8 deletions(-)
diff --git a/docs/img/fetchfiles.png b/docs/img/fetchfiles.png
new file mode 100644
index 0000000..56c6648
Binary files /dev/null and b/docs/img/fetchfiles.png differ
diff --git a/docs/img/managestorage.png b/docs/img/managestorage.png
new file mode 100644
index 0000000..a8eacd0
Binary files /dev/null and b/docs/img/managestorage.png differ
diff --git a/docs/img/sshkeygen.png b/docs/img/sshkeygen.png
new file mode 100644
index 0000000..519b0c0
Binary files /dev/null and b/docs/img/sshkeygen.png differ
diff --git a/docs/img/usersettings.png b/docs/img/usersettings.png
new file mode 100644
index 0000000..401288c
Binary files /dev/null and b/docs/img/usersettings.png differ
diff --git a/docs/user-documentation/monitor-experiment.md b/docs/user-documentation/monitor-experiment.md
index b378f55..2e8a1c4 100644
--- a/docs/user-documentation/monitor-experiment.md
+++ b/docs/user-documentation/monitor-experiment.md
@@ -6,7 +6,7 @@
##### <h5 id="monexp">Monitor Experiments</h5>
1. Individual experiment status can be monitored from 'Experiment Summary Page'.
-2. User can also view all the experimetns statuses from 'Experiment Browse' page as well and further monitory a selected specific one.
+2. User can also view all the experiment s statuses from 'Experiment Browse' page as well and further monitory a selected specific one.
2. Based on your permission level you would have access to information.
3. Generally as soon as you create your login and access this page, you would see grayed out "Applications" (See Image: Portal Workspace)
4. Applications are your tools or codes that you would select to launch jobs ar remote resources.
@@ -28,4 +28,9 @@ Image: Experiment Summary with Active Job
Image: Experiment Summary with Completed Job & Outputs
-##### <h5 id="monjob">Monitor Jobs</h5>
\ No newline at end of file
+##### <h5 id="fetchfile">Fetch Intermediate Files</h5>
+1. Once the job is submitted to remote resource and active, users have the option os fetching configured output files for the application.
+
+2. For each file, there is a button to fetch them and user can view the files to decide to keep the job or to cancel.
+
+Image: Fetching Intermediate Files
\ No newline at end of file
diff --git a/docs/user-documentation/other-features.md b/docs/user-documentation/other-features.md
index f32baad..0d0ce1e 100644
--- a/docs/user-documentation/other-features.md
+++ b/docs/user-documentation/other-features.md
@@ -1,8 +1,45 @@
##Django Gateway Theme Management
What else is available for you in the gateway portal?
-- Create Projects
-- Manage Storage
-- Update User Settings
-- Generate Own SSH Keys
-- Keep an Eye on Notices
\ No newline at end of file
+<br></br>
+- <a href= "#createproj">Create Projects</a></br>
+- <a href= "#storage">Manage Storage</a></br>
+- <a href= "#usersettings">Update User Settings</a></br>
+- <a href= "#sshgen">Generate Own SSH Keys</a></br>
+- <a href= "#viewnotices">Keep an Eye on Notices</a></br>
+
+
+##### <h5 id="createproj">Create Projects</h5>
+1. The gateway has the 'Default Project' created for you. You can us this project as a holder for your experiments.
+2. Apart from the system created one, you can also create your own projects to hold your experiments; a mechanism of grouping your experiments.
+3. Projects can also be share with other gateway users and gateway user groups.
+4. When you share, you can set permissions to either READ, WRITE or MANAGE_SHARING.
+
+
+##### <h5 id="storage">Manage Storage</h5>
+1. Using the "Storage" page, users can manage their existing data files, upload new files, create new directory structures and also get rid of existing files and directories.
+2. Users also have the option of downloading files and directories from this page.
+3. The storage will show the sizes of each directory and each file to the user.
+4. When creating experiments users have the option of uploading files existing in the storage.
+
+
+Image: Manage Storage
+
+##### <h5 id="usersettings">Update User Settings</h5>
+1. The "User Settings" will enable you to change your details and email within the gateway.
+2. When changing email, its only accepted after the email verification step. You would be displayed "Once you verify your email address at testing.email@gmail.com, your email address will be updated. If you didn't receive the verification email, click here to resend verification link."
+
+
+Image: User Profile Editor
+
+##### <h5 id="sshgen">Generate Own SSH Keys</h5>
+1. This is for you to generate your own SSH SSH credentials to use to connect to your own allocations through the gateway.
+2. As a generic gateway user keys you generate are invincible to everyone else.
+3. But always you hav the option of sharing it with any other user or user group with permissions; READ, WRITE or MANAGE_SHARING
+
+Image: Generate New SSH Credentials
+
+##### <h5 id="viewnotices">Keep an Eye on Notices</h5>
+1. Pretty much what the title says, on the top menu you would see the 'Bell' and you can view notices by the gateway admin.
+2. You also have the option of "Mark as Read"
+3. The messages has an expiration set by the gateway admin and upon expiring it will get removed from the list.
diff --git a/docs/user-documentation/quick-start.md b/docs/user-documentation/quick-start.md
index 62dc83c..0d34b67 100644
--- a/docs/user-documentation/quick-start.md
+++ b/docs/user-documentation/quick-start.md
@@ -23,5 +23,6 @@ Image: Create Experiment Page
<br>For more information refer: <a href="/user-documentation/clone-cancel-share" target="_blank">Clone, Cancel or Share your Experiment and Job</a><br>
<br></br>
+6. Users can also fetch intermediate files while the job is active in remote resource. This is useful especially for long running jobs, as you can monitor th results and take necessary steps as needed.
diff --git a/docs/user-documentation/tutorial.md b/docs/user-documentation/tutorial.md
index 13842b8..e8daaf3 100644
--- a/docs/user-documentation/tutorial.md
+++ b/docs/user-documentation/tutorial.md
@@ -27,7 +27,7 @@
<br></br>
5. You can click on the file to take a quick look at the file in a popup window.
<br></br>
-6. Now we'll select what account to charge and where to run this job. The Allocation field should already have Default selected. Under Compute Resource make sure you select Expanse.
+6. Now we'll select what account to charge and where to run this job. Use "Resource Reservation for Tutorials" allocation for the job. Under Compute Resource make sure you select Expanse.
<br></br>
7. Then click Save and Launch.
<br></br>