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/06 05:12:50 UTC
[airavata-user-docs] branch main updated: Updating the Airavata user docs
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 222266c Updating the Airavata user docs
222266c is described below
commit 222266c5ca419c13e8903a68ffaee447de6adcf8
Author: eroma2014 <er...@gmail.com>
AuthorDate: Wed Jul 6 01:11:58 2022 -0400
Updating the Airavata user docs
---
docs/contact-us.md | 4 +-
docs/img/app-catalog.png | Bin 102779 -> 0 bytes
docs/img/cilogon.png | Bin 0 -> 368576 bytes
docs/img/create-account.png | Bin 0 -> 257415 bytes
docs/img/createexp.png | Bin 0 -> 293571 bytes
docs/img/createusergroups.png | Bin 0 -> 292626 bytes
docs/img/django-dashboard.png | Bin 257088 -> 0 bytes
docs/img/expactions.png | Bin 0 -> 213797 bytes
docs/img/expbrowse.png | Bin 0 -> 396885 bytes
docs/img/gau-app-dep.png | Bin 288474 -> 0 bytes
docs/img/gau-app-detail-tab.png | Bin 186052 -> 0 bytes
docs/img/gau-app-input.png | Bin 311857 -> 0 bytes
docs/img/gau-app-int-1.png | Bin 226844 -> 0 bytes
docs/img/gau-app-int-2.png | Bin 212219 -> 0 bytes
docs/img/gau-app-int-3.png | Bin 106055 -> 0 bytes
docs/img/gau-app-mod.png | Bin 39446 -> 0 bytes
docs/img/gau-app-output1.png | Bin 116166 -> 0 bytes
docs/img/gau-app-output2.png | Bin 147580 -> 0 bytes
docs/img/gau-app-output3.png | Bin 164244 -> 0 bytes
docs/img/helix-architecture.png | Bin 350606 -> 0 bytes
docs/img/home-page.png | Bin 259533 -> 0 bytes
docs/img/home-page2.png | Bin 3137380 -> 0 bytes
docs/img/login-page.png | Bin 163897 -> 0 bytes
docs/img/monitorexpjob.png | Bin 0 -> 269334 bytes
docs/img/monitorexpjobcomp.png | Bin 0 -> 302959 bytes
docs/img/monitoring-framework.jpg | Bin 197321 -> 0 bytes
docs/img/multiple-ways-to-use-airavata-1.png | Bin 129098 -> 0 bytes
docs/img/multiple-ways-to-use-airavata.png | Bin 72711 -> 0 bytes
docs/img/nek-5000-app-mod.png | Bin 47097 -> 0 bytes
docs/img/nek-5000-job.png | Bin 247133 -> 0 bytes
docs/img/nek-app-int-1.png | Bin 310761 -> 0 bytes
docs/img/nek-app-int-2.png | Bin 85506 -> 0 bytes
docs/img/nek-app-int-3.png | Bin 77513 -> 0 bytes
docs/img/nek-app-int-4.png | Bin 82900 -> 0 bytes
docs/img/nek-app-int-5.png | Bin 128004 -> 0 bytes
docs/img/nek-app-int-6.png | Bin 123292 -> 0 bytes
docs/img/nek-app-int-7.png | Bin 65519 -> 0 bytes
docs/img/pga-menu-and-sub-menu.png | Bin 102694 -> 0 bytes
docs/img/shareexp.png | Bin 0 -> 331660 bytes
docs/img/user-profiles-old.png | Bin 101847 -> 0 bytes
docs/img/user-profiles.png | Bin 78923 -> 0 bytes
docs/img/user-settings.png | Bin 108768 -> 0 bytes
docs/img/viewusergroups.png | Bin 0 -> 202998 bytes
docs/img/wagtail-child-edit.png | Bin 245259 -> 0 bytes
docs/img/wagtail-home-edit.png | Bin 166353 -> 0 bytes
docs/img/wagtail-home.png | Bin 369726 -> 0 bytes
docs/img/wagtail-nav.png | Bin 161065 -> 0 bytes
docs/img/workspace.png | Bin 0 -> 580952 bytes
docs/index.md | 36 +--
docs/user-documentation/JSON-tutorials.md | 181 -------------
docs/user-documentation/account-creation.md | 27 ++
docs/user-documentation/admin-tutorials.md | 286 ---------------------
docs/user-documentation/airavata-user-profiles.md | 56 ----
docs/user-documentation/clone-cancel-share.md | 42 +++
.../create-experiment-launch-job.md | 31 +++
docs/user-documentation/create-groups.md | 25 ++
docs/user-documentation/django-documenation.md | 0
docs/user-documentation/monitor-experiment.md | 27 ++
.../{cms-tutorials.md => other-features.md} | 0
docs/user-documentation/personal-allocation.md | 26 ++
docs/user-documentation/quick-start.md | 25 ++
docs/user-documentation/supported-applications.md | 2 +-
docs/user-documentation/user-tutorials.md | 3 -
mkdocs.yml | 45 +---
64 files changed, 239 insertions(+), 577 deletions(-)
diff --git a/docs/contact-us.md b/docs/contact-us.md
index 5364880..0f758df 100644
--- a/docs/contact-us.md
+++ b/docs/contact-us.md
@@ -1,12 +1,12 @@
## Contact Us
-To request for a gateway with Apache Airavata create an account in <a href="https://scigap.org/" target="_blank">SciGaP Portal</a><br>
+To request a gateway with Apache Airavata create an account in <a href="https://scigap.org/" target="_blank">SciGaP Portal</a><br>
Submit a request using the online application. <br>
We will contact you to discuss your requirement and provide you with the best Solution for You!
For your clarifications, Questions and Suggestions please contact us through
-<a href="http://airavata.apache.org/community/mailing-lists.html" target="_blank">Airavata mailing list</a>
+<a href="https://airavata.apache.org/mailing-list.html" target="_blank">Airavata mailing list</a>
OR
diff --git a/docs/img/app-catalog.png b/docs/img/app-catalog.png
deleted file mode 100644
index 55a8d8b..0000000
Binary files a/docs/img/app-catalog.png and /dev/null differ
diff --git a/docs/img/cilogon.png b/docs/img/cilogon.png
new file mode 100644
index 0000000..0b207f2
Binary files /dev/null and b/docs/img/cilogon.png differ
diff --git a/docs/img/create-account.png b/docs/img/create-account.png
new file mode 100644
index 0000000..855cff2
Binary files /dev/null and b/docs/img/create-account.png differ
diff --git a/docs/img/createexp.png b/docs/img/createexp.png
new file mode 100644
index 0000000..3612edc
Binary files /dev/null and b/docs/img/createexp.png differ
diff --git a/docs/img/createusergroups.png b/docs/img/createusergroups.png
new file mode 100644
index 0000000..8dc35da
Binary files /dev/null and b/docs/img/createusergroups.png differ
diff --git a/docs/img/django-dashboard.png b/docs/img/django-dashboard.png
deleted file mode 100644
index 1ecb6d1..0000000
Binary files a/docs/img/django-dashboard.png and /dev/null differ
diff --git a/docs/img/expactions.png b/docs/img/expactions.png
new file mode 100644
index 0000000..a3f7984
Binary files /dev/null and b/docs/img/expactions.png differ
diff --git a/docs/img/expbrowse.png b/docs/img/expbrowse.png
new file mode 100644
index 0000000..11fcd25
Binary files /dev/null and b/docs/img/expbrowse.png differ
diff --git a/docs/img/gau-app-dep.png b/docs/img/gau-app-dep.png
deleted file mode 100644
index b7b23ce..0000000
Binary files a/docs/img/gau-app-dep.png and /dev/null differ
diff --git a/docs/img/gau-app-detail-tab.png b/docs/img/gau-app-detail-tab.png
deleted file mode 100644
index f7c305d..0000000
Binary files a/docs/img/gau-app-detail-tab.png and /dev/null differ
diff --git a/docs/img/gau-app-input.png b/docs/img/gau-app-input.png
deleted file mode 100644
index 256c54a..0000000
Binary files a/docs/img/gau-app-input.png and /dev/null differ
diff --git a/docs/img/gau-app-int-1.png b/docs/img/gau-app-int-1.png
deleted file mode 100644
index 435f1c9..0000000
Binary files a/docs/img/gau-app-int-1.png and /dev/null differ
diff --git a/docs/img/gau-app-int-2.png b/docs/img/gau-app-int-2.png
deleted file mode 100644
index b654ba2..0000000
Binary files a/docs/img/gau-app-int-2.png and /dev/null differ
diff --git a/docs/img/gau-app-int-3.png b/docs/img/gau-app-int-3.png
deleted file mode 100644
index e466a46..0000000
Binary files a/docs/img/gau-app-int-3.png and /dev/null differ
diff --git a/docs/img/gau-app-mod.png b/docs/img/gau-app-mod.png
deleted file mode 100644
index 68e5875..0000000
Binary files a/docs/img/gau-app-mod.png and /dev/null differ
diff --git a/docs/img/gau-app-output1.png b/docs/img/gau-app-output1.png
deleted file mode 100644
index ece7689..0000000
Binary files a/docs/img/gau-app-output1.png and /dev/null differ
diff --git a/docs/img/gau-app-output2.png b/docs/img/gau-app-output2.png
deleted file mode 100644
index 198742a..0000000
Binary files a/docs/img/gau-app-output2.png and /dev/null differ
diff --git a/docs/img/gau-app-output3.png b/docs/img/gau-app-output3.png
deleted file mode 100644
index f549dfa..0000000
Binary files a/docs/img/gau-app-output3.png and /dev/null differ
diff --git a/docs/img/helix-architecture.png b/docs/img/helix-architecture.png
deleted file mode 100644
index 0f78b39..0000000
Binary files a/docs/img/helix-architecture.png and /dev/null differ
diff --git a/docs/img/home-page.png b/docs/img/home-page.png
deleted file mode 100644
index 31953ba..0000000
Binary files a/docs/img/home-page.png and /dev/null differ
diff --git a/docs/img/home-page2.png b/docs/img/home-page2.png
deleted file mode 100644
index 3dc1d68..0000000
Binary files a/docs/img/home-page2.png and /dev/null differ
diff --git a/docs/img/login-page.png b/docs/img/login-page.png
deleted file mode 100644
index 8a01c1a..0000000
Binary files a/docs/img/login-page.png and /dev/null differ
diff --git a/docs/img/monitorexpjob.png b/docs/img/monitorexpjob.png
new file mode 100644
index 0000000..f2f4a9f
Binary files /dev/null and b/docs/img/monitorexpjob.png differ
diff --git a/docs/img/monitorexpjobcomp.png b/docs/img/monitorexpjobcomp.png
new file mode 100644
index 0000000..d49d559
Binary files /dev/null and b/docs/img/monitorexpjobcomp.png differ
diff --git a/docs/img/monitoring-framework.jpg b/docs/img/monitoring-framework.jpg
deleted file mode 100644
index 226b009..0000000
Binary files a/docs/img/monitoring-framework.jpg and /dev/null differ
diff --git a/docs/img/multiple-ways-to-use-airavata-1.png b/docs/img/multiple-ways-to-use-airavata-1.png
deleted file mode 100644
index 38fa949..0000000
Binary files a/docs/img/multiple-ways-to-use-airavata-1.png and /dev/null differ
diff --git a/docs/img/multiple-ways-to-use-airavata.png b/docs/img/multiple-ways-to-use-airavata.png
deleted file mode 100644
index 59ffed3..0000000
Binary files a/docs/img/multiple-ways-to-use-airavata.png and /dev/null differ
diff --git a/docs/img/nek-5000-app-mod.png b/docs/img/nek-5000-app-mod.png
deleted file mode 100644
index c0b8673..0000000
Binary files a/docs/img/nek-5000-app-mod.png and /dev/null differ
diff --git a/docs/img/nek-5000-job.png b/docs/img/nek-5000-job.png
deleted file mode 100644
index a3f919a..0000000
Binary files a/docs/img/nek-5000-job.png and /dev/null differ
diff --git a/docs/img/nek-app-int-1.png b/docs/img/nek-app-int-1.png
deleted file mode 100644
index fcb572f..0000000
Binary files a/docs/img/nek-app-int-1.png and /dev/null differ
diff --git a/docs/img/nek-app-int-2.png b/docs/img/nek-app-int-2.png
deleted file mode 100644
index 0200420..0000000
Binary files a/docs/img/nek-app-int-2.png and /dev/null differ
diff --git a/docs/img/nek-app-int-3.png b/docs/img/nek-app-int-3.png
deleted file mode 100644
index 011cd08..0000000
Binary files a/docs/img/nek-app-int-3.png and /dev/null differ
diff --git a/docs/img/nek-app-int-4.png b/docs/img/nek-app-int-4.png
deleted file mode 100644
index 54930f1..0000000
Binary files a/docs/img/nek-app-int-4.png and /dev/null differ
diff --git a/docs/img/nek-app-int-5.png b/docs/img/nek-app-int-5.png
deleted file mode 100644
index edc2591..0000000
Binary files a/docs/img/nek-app-int-5.png and /dev/null differ
diff --git a/docs/img/nek-app-int-6.png b/docs/img/nek-app-int-6.png
deleted file mode 100644
index 80ac815..0000000
Binary files a/docs/img/nek-app-int-6.png and /dev/null differ
diff --git a/docs/img/nek-app-int-7.png b/docs/img/nek-app-int-7.png
deleted file mode 100644
index f96fbae..0000000
Binary files a/docs/img/nek-app-int-7.png and /dev/null differ
diff --git a/docs/img/pga-menu-and-sub-menu.png b/docs/img/pga-menu-and-sub-menu.png
deleted file mode 100644
index 266602e..0000000
Binary files a/docs/img/pga-menu-and-sub-menu.png and /dev/null differ
diff --git a/docs/img/shareexp.png b/docs/img/shareexp.png
new file mode 100644
index 0000000..4f3515b
Binary files /dev/null and b/docs/img/shareexp.png differ
diff --git a/docs/img/user-profiles-old.png b/docs/img/user-profiles-old.png
deleted file mode 100644
index 3685437..0000000
Binary files a/docs/img/user-profiles-old.png and /dev/null differ
diff --git a/docs/img/user-profiles.png b/docs/img/user-profiles.png
deleted file mode 100644
index 2a24a48..0000000
Binary files a/docs/img/user-profiles.png and /dev/null differ
diff --git a/docs/img/user-settings.png b/docs/img/user-settings.png
deleted file mode 100644
index 4c03e0e..0000000
Binary files a/docs/img/user-settings.png and /dev/null differ
diff --git a/docs/img/viewusergroups.png b/docs/img/viewusergroups.png
new file mode 100644
index 0000000..f60353b
Binary files /dev/null and b/docs/img/viewusergroups.png differ
diff --git a/docs/img/wagtail-child-edit.png b/docs/img/wagtail-child-edit.png
deleted file mode 100644
index 6b466f7..0000000
Binary files a/docs/img/wagtail-child-edit.png and /dev/null differ
diff --git a/docs/img/wagtail-home-edit.png b/docs/img/wagtail-home-edit.png
deleted file mode 100644
index 9dd86ab..0000000
Binary files a/docs/img/wagtail-home-edit.png and /dev/null differ
diff --git a/docs/img/wagtail-home.png b/docs/img/wagtail-home.png
deleted file mode 100644
index 7b03c28..0000000
Binary files a/docs/img/wagtail-home.png and /dev/null differ
diff --git a/docs/img/wagtail-nav.png b/docs/img/wagtail-nav.png
deleted file mode 100644
index 7b352f9..0000000
Binary files a/docs/img/wagtail-nav.png and /dev/null differ
diff --git a/docs/img/workspace.png b/docs/img/workspace.png
new file mode 100644
index 0000000..fd76a8e
Binary files /dev/null and b/docs/img/workspace.png differ
diff --git a/docs/index.md b/docs/index.md
index 148cbb2..61c558c 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -1,29 +1,35 @@
-# Apache Airavata
+# Django Portal General User Documentation
+###Airavata Middleware
- A distributed framework that supports execution and management of computational scientific applications and workflows in grid based systems, remote clusters and cloud based systems.
- Primarily focused on submitting and managing application executions and workflows in grid based systems.
-- Architecturally extensible to support other underlying resources.
-- Used by scientific gateway developers as their middleware layer. They can directly call Airavata API in order to communicate with grid based system.
+- Architecturally extensible to support other underlying resources.<!-- Used by scientific gateway developers as their middleware layer. They can directly call Airavata API in order to communicate with grid based system.-->
- Provides a desktop tools and browser-based web interface components for managing applications, workflows and generated data.
- Contains sophisticated server-side tools for registering and managing scientific applications on computational resources.
-- The Django portal provides tools and methods to easily integrate with post processing applications and application centric interfaces.
-For more information on Airavata visit; <a href="http://airavata.apache.org/" target="_blank">Apache Airavata</a>
+### Django Portal
+- The Django portal, the 'Science Gateway' provides tools and methods to easily integrate with post processing applications and application centric interfaces.
+- Django portal is the users interface to use services available through Apache Airavata Middleware.
+- Django portal mainly has 3 user groups; General User, Read-only- admin user and Admin user
+- This documentation provides step by step instructions on functionality available for general users.
+
+
+
+More information on <a href="https://airavata.apache.org/" target="_blank">Apache Airavata</a><br>
+More information on <a href="https://apache-airavata-django-portal.readthedocs.io/en/latest/" target="_blank">Django Portal</a>
<br>
<br>
-<button type="button" style="color:#f2f2f2;text-align:center;font-weight:lighter;background-color:#2481b9;width:220px;border: 2px solid #2481b9;border-radius:4px"><a style="color:white" href="user-documentation/Django-Instructions" target="_blank" ><b>Django Gateway</b><br/><br/>Django Gateway admin and general user instructions & tutorials!</br></br>Collection of tutorials and instructions for gateway set-up.</a></button>
-<button type="button" style="color:#f2f2f2;text-align:center;font-weight:lighter;background-color:#2481b9;width:220px;border: 2px solid #2481b9;border-radius:4px"><a style="color:white" href="user-documentation/Custos-Instructions" target="_blank" ><b>Data Portal</b><br/><br/>User docs for Data Portal admins and general users</br>Tutorials for gateway users. </br></br><br/>Assistance with job submission, management and sharing!.</a></button>
-<button type="button" style="color:#f2f2f2;text-align:center;font-weight:lighter;background-color:#2481b9;width:220px;border: 2px solid #2481b9;border-radius:4px"><a style="color:white" href="installation/EMC-Instructions" target="_blank"><b>Custos</b><br/><br/>Manage user access? </br></br>Configuration instructions for Custos users & Tutorial!<br/></br></a></button>
+<button type="button" style="color:#f2f2f2;text-align:center;font-weight:lighter;background-color:#2481b9;width:220px;border: 2px solid #2481b9;border-radius:4px"><a style="color:white" href="user-documentation/quick-start" target="_blank" ><br/><br/><b>General User Quick Start</b><br/></br></br></a></button>
+<button type="button" style="color:#f2f2f2;text-align:center;font-weight:lighter;background-color:#2481b9;width:220px;border: 2px solid #2481b9;border-radius:4px"><a style="color:white" href="user-documentation/account-creation" target="_blank" ><br/><br/><b>Portal Account Creation</b><br/></br></br></a></button>
+<button type="button" style="color:#f2f2f2;text-align:center;font-weight:lighter;background-color:#2481b9;width:220px;border: 2px solid #2481b9;border-radius:4px"><a style="color:white" href="installation/EMC-Instructions" target="_blank"><br/><br/><b>Launch Jobs on HPCs</b><br/></br><br/></a></button>
+<button type="button" style="color:#f2f2f2;text-align:center;font-weight:lighter;background-color:#2481b9;width:220px;border: 2px solid #2481b9;border-radius:4px"><a style="color:white" href="user-documentation/Custos-Instructions" target="_blank" ><br/><br/><b>Other Features</b><br/><br></br></a></button>
<!--<button type="button" style="color:#f2f2f2;text-align:center;font-weight:lighter;background-color:#2481b9;width:220px;border: 2px solid #2481b9;border-radius:4px"><a style="color:white" href="http://airavata.readthedocs.io/en/latest/ target="_blank"><b>User Guide</b></br><br>In-detail documentation on how to install, configure and do upgrades for gateway admins.</br>Step by step guide for gateway users as well.</br></a></button>-->
<br></br>
<!--The Installation section of the documentation applies to on-premise installation of Apache Airavata. -->
-/*
-<b>If you are interested in </b><br>
-1. Using an already hosted gateway<br>
-OR<br>
-2. Having your own gateway hosted<br>
-you can contact a downstream project <a href="http://scigap.org/" target="_blank">Science Gateways Platform as a Service (SciGaP)</a> and request your gateway.
-<br>SciGaP runs Apache Airavata as a platform service. */
+
+###Latest on Django Release !
+<b>July release user documentation </b><br>
+1. Coming Soon!
diff --git a/docs/user-documentation/JSON-tutorials.md b/docs/user-documentation/JSON-tutorials.md
deleted file mode 100644
index 8a01389..0000000
--- a/docs/user-documentation/JSON-tutorials.md
+++ /dev/null
@@ -1,181 +0,0 @@
-##Advance Application Input Configuration
-
-###Introduction
-
-The Django portal for Apache Airavata middleware is new and caters to wider range of requirements from Gateways. <br>
-
-One major requirement was more flexibility in application inputs. In the previous PGA, inputs were Integer, String, Number and URI.
-User requirements were to have more options when adding these input types to their applications, such as option buttons, Cascading inputs, etc…
-
-In Django in order to advance the input types JSON scripting is used.
-When using JSON scripting, prior the developer/gateway admin need to add the component in to Django framework in order for it to work.
-
-###String Input Validations
-
-1. When String Inputs are provided, gateway to be able to
- - Define a minimum and a maximum length
- - Define valid characters (only X, Y, Z and 1)
- - Provide validation messages for users.
- - Ignore spaces between letters.
-2. A text consisting X, Y, Z with minimum 10 character length and maximum 200 character length.
-```
-{
- "editor": {
- "ui-component-id": "textarea-input-editor",
- "config": {
- "rows": 6
- },
- "validations": [
- {
- "type": "min-length",
- "value": 10
- },
- {
- "type": "max-length",
- "value": 200
- },
- {
- "type": "regex",
- "value": "^[XYL\\s]+$",
- "message": "Target sequence may only contain letters X, Y and L."
- }
- ]
- }
- }
-```
-3. “\\\s” in the value confirms ignoring any spaces in the sequence.
-
-###Input List Validations
-####Check Boxes
-1. When providing inputs, users may need to provide one or many for a single input.
-```
-{
- "editor": {
- "ui-component-id": "checkbox-input-editor",
- "config": {
- "options": [
- {
- "value": "a",
- "text": "A label"
- },
- {
- "value": "b",
- "text": "B label"
- },
- {
- "value": "c",
- "text": "C label"
- }
- ]
- }
- }
-}
-```
-
-####Radio Buttons
-1. When users are required to select only one input value this is used. If there are more than 6 to select List-of-Values is a better option.
-2. If you need to define a ‘default’ value, add the ‘value’ of that option in the Value field in application input. E.g.: If the default is lunch, then the value ‘lunch’ should be added to the Value field in Application input.
-```
-{
- "editor": {
- "ui-component-id": "radio-button-input-editor",
- "config": {
- "options": [
- {
- "value": "breakfast",
- "text": "Breakfast"
- },
- {
- "value": "lunch",
- "text": "Lunch"
- },
- {
- "value": "dinner",
- "text": "Dinner"
- }
- ]
- }
- }
-}
-```
-
-####Lists
-1. This is where the list is longer than 6 values.
-2. A list longer than 6 values are two lengthy to display as option buttons. Users can use LOVs ( List of Values) if only a single value to be selected, and checkboxes if multiple values are required.
-
-###Cascading Inputs
-1. Cascading inputs are child inputs based on a prior selection.
-2. E.g.: Show value B if value for A is ‘Pizza’. If the input for A is ‘pizza’ Then display B with its values for user to select.
-
-```
-{
- "editor": {
- "dependencies": {
- "show": {
- "OR": [
- {
- "A": {
- "comparison": "equals",
- "value": "pizza"
- }
- },
- {
- "C": {
- "comparison": "equals",
- "value": "cake"
- }
- }
- ]
- }
- }
- }
-}
-```
-
-3. In above, OR means that B to display if value for A is ‘pizza’ or value for C is ‘cake’. In place of OR can use AND and NOT.
-4. To toggle properties on the input field, such as "requiredToAddedToCommandLine", add "showOptions" to the JSON config with a value of "toggle" and the names of properties to toggle:
-```
-{
- "editor": {
- "dependencies": {
- "show": {
- "OR": [
- {
- "A": {
- "comparison": "equals",
- "value": "pizza"
- }
- },
- {
- "C": {
- "comparison": "equals",
- "value": "cake"
- }
- }
- ]
- },
- "showOptions": {
- "toggle": ["requiredToAddedToCommandLine"]
- }
- }
- }
-}
-```
-
-###Dependant File Uploads
-1. Dependant input is a input that is dependant on certain option selected in a previous field. E.g.: If the option selected is ‘list-of-urls’ then show this field to upload a file.
-2. If the selected option is ‘list-of-urls’ then the URI upload should be enabled.
-```
-{
- "editor": {
- "dependencies": {
- "show": {
- "Select reading options": {
- "comparison": "equals",
- "value": "list-urls"
- }
- }
- }
- }
-}
-```
\ No newline at end of file
diff --git a/docs/user-documentation/account-creation.md b/docs/user-documentation/account-creation.md
new file mode 100644
index 0000000..4afb1ec
--- /dev/null
+++ b/docs/user-documentation/account-creation.md
@@ -0,0 +1,27 @@
+## Portal Account Creation
+- Two ways to create your account and get access
+ - <a href= "#Exist Login">Use Existing Institutional Login</a></br>
+ - <a href= "#Local">Create Local Account</a></br>
+
+
+Image: Create Account Page
+##### <h5 id="Exist Login">Use Existing Institutional Login</h5><br>
+1. This is the mostly used option.
+2. Click "Sign in with existing institutional credentials" button.
+3. In the next window choose your institute or google as the option.
+4. After institutional redirection, now you have access to the portal "Workspace". <br>
+ TIP: Still you may not have permission to actually launch jobs, but your gateway admin will take care of it.
+
+Image: Institutional Selection Page
+
+
+##### <h5 id="Local">Create Local Account</h5>
+1. In your portal navigate to Account Creation (e.g.: https://testdrive.airavata.org/auth/create-account)
+2. For local account creation provides the details under "Create an Airavata Test Drive Gateway account"
+3. Once you submit, you would receive an email verification <br>
+ TIP: This mail could land in your spam, so keep an eye!
+4. Verify your email and you will be in your portal "Workspace"! <br>
+ TIP: Still you may not have permission to actually launch jobs, but your gateway admin will take care of it.
+
+
+
diff --git a/docs/user-documentation/admin-tutorials.md b/docs/user-documentation/admin-tutorials.md
deleted file mode 100644
index eb5380a..0000000
--- a/docs/user-documentation/admin-tutorials.md
+++ /dev/null
@@ -1,286 +0,0 @@
-## Gateway Admin Tutorial
-
-###Quick Admin Instructions
-This documentation is a quick set-up instructions for gateway Settings configurations for Admins. For more details please refer to tutorials provide as well.
-<a href="https://cwiki.apache.org/confluence/display/AIRAVATA/Django+Portal+for+Airavata%3A+Gateway+Admin+Guide" target="_blank"> Django Portal Admin Instructions</a>
-
-## Gateway Admin Tutorials
-### Prior to starting your configurations
-1. You need to have admin access to the Django portal, Settings. You need to be a member of the Admin Group.
- - How to check?
- - Log in to the gateway portal
- - You would land on Dashboard with all the applications you have access to launch jobs.
- - Click 'Settings' from top right drop down menu.
- - Do you see icon 'Application Catalog' ? In it can you create applications using 'New Application +'?.
- - Then you are good !<br>
- - If not, contact your gateway admin OR SciGaP team
-<!--3. Credentials generated, assigned and added to authorized_keys files of compute resources -->
-<!--- To generate key refer [Credential Store](../configuration/pga-configuration.md#credential-store)-->
-<!-- - Token Assignment [Gateway Management](../configuration/pga-configuration.md#gateway-management-of-resources)-->
-<!-- - Copy the public key for the assigned token frm credential store and add it to authorized_keys file in both compute and storage resources.-->
-
-<!--NOTE: If you are using a hosted gateway the 2 and 4 would be taken cared by the SciGaP team. -->
-
-
-### Select Your Quick Start Tutorial
-1. <a href= "#Secure">Using Credential Store</a></br>
-2. <a href= "#Resources">Register your Compute & Storage Resources</a></br>
-3. <a href= "#GroupResourceProfile">Configure Group Resource Profile (GRP)</a></br>
-4. <a href="#GaussianJob">Register Gaussian Application</a></br>
-8. <a href= "#StorePreference">Gateway Resource Profile</a></br>
-9. <a href= "#GtwyAccess">Managing User Accounts & User Groups</a></br>
-10. <a href= "#Notices">Communication with Gateway Users</a></br>
-11. <a href= "#Traffic">Monitor Gateway Traffic</a></br>
-
-
-##### <h5 id="Secure">Using Credential Store</h5>
-1. Navigate to Settings → Credential Store.
-2. Click 'New SSH Credential +' and provide a key description.
-3. The new key will be generated and available to copy.
-4. Apart from using the key for SSH communications with compute resources and gateway storage resource, you can share the key with other gateway users and user groups.
-5. When sharing a key, there are 3 permission levels, READ, WRITE and MANAGE_SHARING.
-6. READ permission enables the users to use the key, WRITE permission enables using the key plus deleting the key. MANAGE_SHARING is use the key, delete it and also share with other users and user groups behalf of the owner of the key.
-7. NOTE: Make sure not to delete once assigned to a compute resource or the storage resource. </br>
-
-
-
-##### <h5 id="Resources">Register your Compute & Storage Resources</h5><br>
-
-<b class="lred"> NOTE:</b> Only SciGaP admins or gateway service provider can add compute resources and storage resources. <br> If the gateway and middleware is hsoted by you, You can add the Compute Resources and Storage Resource.
-<br></br><b>What is a compute resource? </b><br>A compute resource is an object that represents a host, host cluster, or pool in a virtualization platform, a virtual data center, or an Amazon region on which machines can be provisioned.
-<br>Compute resource could come as national resources, campus resources or even private cluster.
-<br>NOTE:For testing purposes users (mainly gateway developers) this could even be the local machine.
-<br></br><b>What is a storage resource?</b><br>A storage resource is the server that stores all user data files: application input files and output files.
-<br>Most of the time this is the same server that the gateway is deployed in. The storage resource can be either provided by the gateway provider or by you.
-<br>If the gateway service provider is providing the resource, then there will be file retention policies in place.
-
-###### <b><u>Compute Resource Information </u></b>
-Provide the information below to get your compute resource/HPC registered with Super admin portal, <a href="https://scigap.org/" target="_blank">SciGaP</a><br>
-1. HPC Name (This is the name used to SSH to the resource)<br>
-2. Queue details (Queue name, maximum limits of nodes, CPUs and Walltime.)<br>
-3. Resource manager type (SLURM, PBS)<br>
-4. Job command binary path <br>
-
-###### <b><u>Register a XSEDE Resource </u></b>
-NOTE: Please note this set of instructions are ONLY for gateways hosted by the user. If not SciGaP admins will do this configuration for you in <a href="https://scigap.org/" target="_blank">SciGaP Portal</a>. <br>
-1. Navigate to Admin Dashboard → Compute Resource → Register <br>
-2. Provide
- - Host Name: comet.sdsc.edu<br>
- - Host Aliases: <br>
- - IP Addresses:<br>
- - Resource Description: SDSC Comet Cluster ( Just a description)<br>
- - Create<br>
-3. In Queues tab<br>
- - Click 'Add a Queue'<br>
- - Queue 1
- - Queue Name: compute ( Per resource this is a unique value. Once created cannot edit the name. If need to change, delete and create again)<br>
- - Queue Description: Used for access to regular compute nodes<br>
- - Queue Max Run Time (In Minutes): 280 (Note required for the local resource)<br>
- - Queue Max Nodes: 72 (Note required for the local resource)<br>
- - Queue Max Processors: 1728 (Note required for the local resource)<br>
- - Max Jobs in Queue: 0 (Note required for the local resource)<br>
- - Max Memory For Queue( In MB ): (Note required for the local resource)<br>
- - Queue 2
- - Queue Name: shared ( Per resource this is a unique value. Once created cannot edit the name. If need to change, delete and create again)<br>
- - Queue Description: Single-node jobs using fewer than 24 cores<br>
- - Queue Max Run Time (In Minutes): 2880 (Note required for the local resource)<br>
- - Queue Max Nodes: 1 (Note required for the local resource)<br>
- - Queue Max Processors: 24 (Note required for the local resource)<br>
- - Max Jobs in Queue: 0 (Note required for the local resource)<br>
- - Max Memory For Queue( In MB ): (Note required for the local resource)<br>
-4. File System<br>
- - Nothing to add here, this is futuristic development.<br>
-5. Job Submission Interface<br>
- - Click on the tab<br>
- - Add a new Job Submission Interface<br>
- - Job Submission Protocol: SSH<br>
- - Select Security Protocol: SSH_KEYS
- - SSH Port: 22
- - Select resource manager type: SLURM<br>
- - Job Manager Bin Path: /usr/bin/
- - Job Commands (SUBMISSION): sbatch<br>
- - Job Commands (JOB_MONITORING): squeue<br>
- - Job Commands (DELETION): scancel<br>
- - Parallelism Prefixes (MPI): mpiexec <br>
- - Add Job Submission Protocol<br>
-6. Data Movement Interface<br>
- - Add a new Data Submission Interface<br>
- - Data Movement Protocol: SCP<br>
- - Select Security Protocol: SSH_KEYS <br>
- - SSH Port: 22 <br>
- - Add Data Movement Protocol<br>
-Now the Local resource is ready for job submissions.<br>
-Comet is ready for job submissions.
-
-###### <b><u>Register a Campus Resource </u></b>
-NOTE: Adding a campus resource is similar to adding a XSEDE resource. Same steps to follow with similar information.
-
-###### <h6 id="StoreR"><b><u>Register Storage Resource</u></b></h6>
-NOTE: Please note this set of instructions are ONLY for gateways hosted by the user. If not SciGaP admins will do this configuration for you in <a href="https://scigap.org/" target="_blank">SciGaP Portal</a>. <br>
-1. Navigate to Admin Dashboard → Storage Resource → Register <br>
-2. Provide <br>
- - Host Name: sg03.iu.xsede.org<br>
- - Storage Resource Description: Storage for airavata gateway<br>
- - Create<br>
-3. In Data Movement Interfaces tab<br>
- - Click 'Add a new Data Movement Interface'<br>
- - Select 'SCP' from the list<br>
- - Select Security Protocol: SSH_KEYS<br>
- - Alternate SSH Host Name: Leave empty<br>
- - SSH Port: 22<br>
- - Add Data Movement Interface<br>
-
-#####<h5 id="GroupResourceProfile">Add a Group Resource Profile for Comet (GRP)</h5>
-1. What is a group resource profile?
- - Group resource profile is a configuration which states how a particular HPC resource (campus, national, cloud) is available for users to use.
- - One or many HPCs can be added to a GRP and then it can be shared with the users and user groups to enable use.
- - A gateway can have multiple GRPs and a gateway user can be in one or many GRPs
- - At the time of experiment creation, user need to select which GRP to move forward to launch experiment jobs.
-2. To Create a GRP
- - Navigate to Settings → Group Resource Profile.
- - Click New Group Resource Profile +.
- - Add Name: Default Gateway Profile
- - Default SSH Credential: Select a key from the list or generate a new one.
- - Click New Compute Resource +.
- - Select the resource from the list provided.
- - In next page provide the details required for SSH communication
- - Login Username: This is the login name to use in SSH login
- - SSH Credential: Select from the list, or generate a new one
- - Allocation Project Number: this is applicable for resources which maintains an account for user allocation and usage.
- - Scratch Location: The location for users' computational working directories
- - Provide computational queue policies
- - This section will provide details of maximum node, walltime and CPUs per HPC resource that a gateway user could use in experiment creation.
- - If you don't specify these limits, then the maximum allowed from the HPC resource will be available for users.
- - NOTE: This feature is more popular with gateways which are used in educational purposes and also for gateways where the gateway admin provides XSEDE resoruces for free via community allocations.
- - Click Save
- - Next page, click Save
-
-
-#####<h5 id="GaussianJob">Register Gaussian Application</h5>
-End of this tutorial you will know how to register a new application to run on a a HPC resource through Django portal.
-
-1. Navigate to Settings → Application Catalog. Click New Application +
-2. In Details tab enter:
- - Enter Application Name: Gaussian16
- - Enter Application Version: Gaussian 16 (Not mandatory)
- - Enter Application Description: Gaussian provides capabilities for electronic structure modeling
- - Save
-
-3. In Interface tab:
- - Set 'Enable Archiving Working Directory' to True (Why? - This is set to true when you want to bring back all the files in working directory back to PGA. Caution: If there are very large files they may not be able to SCP)
- - Set 'Enable Optional File Inputs' to False (Why? - Set to false because there won't be any additional optional inputs for Gaussian)
- - Provide Input Fields
- - Click Add Application Input
- - Name: Input-File
- - Initial Value: gaussian.com
- - Type: URI (Why? - This is the type for file uploads)
- - Application Arguments:
- - Standard Input: False (Why? - Futuristic property and not in real use at the moment)
- - Read Only: False (Why? - this is only meaningful for String, Integer or Float inputs)
- - User Friendly Description: Gaussian input file specifying desired calculation type, model chemistry, molecular system and other parameters. (This is information to the user at creating job experiment. Not mandatory)
- - Data is Staged: False
- - Is the Input Required: True
- - Required in Commandline: True
- - Advanced Input Field Modification Metadata:
- - Provide application outputs</br>
- NOTE: 3 application outputs to define. </br>
- - 1st Output
- - Click Add Application Output
- - Name: Gaussian-Application-Output
- - Value: *.log
- - Type: URI
- - Application Argument:
- - Is the Output required?: True
- - Required on command line?: True
- - Metadata:
- - 2nd output
- - Click Add Application Output
- - Name: Gaussian_Checkpoint_File
- - Value: *.chk
- - Type: URI
- - Application Argument:
- - Data Movement: False
- - Is the Output required?: True
- - Required on command line?: True
- - Metadata
- - For applications, STDOUT and STDERR will be automatically added for you.
- - Search Query:</br>
-
-
-
-
-</br></br>
-3. In Deployment tab
- - Click 'New Deployment +'
- - Click Share and add groups and users you want to share this deployment and let run on the particular cluster.
- - Application Executable Path: /home/gridchem/bin/rung09_with_chk_recovery.sh
- - Application Parallelism Type: SERIAL </br>
- - Application Deployment Description: Gaussian16 Rev A.03 ( to avoid G4 output printing issues in Rev B.01)
- - Application Compute Host: Local (Local machine has to be added as a compute resource prior to this step)
- - Add Module load commands:
- - <pre><code>#SBATCH -N 1</code></pre>
- - export MODULEPATH=/share/apps/compute/modulefiles/applications:$MODULEPATH; module load gaussian/16.B.01
- - Pre Job Commands:
- - export AIRAVATA_USERNAME=$gatewayUserName
- - export AIRAVATA_INPUTS=$inputs
- - export AIRAVATA_ExptDataDir=$experimentDataDir;
- - Default Queue Name: shared
- - Default Node Count: 1
- - Default CPU Count: 4
- - Default Walltime: 30
-
-
-
-##### <h5 id="StorePreference">Gateway Resource Profile </h5>
-1. NOTE: This is the section to configure the storage resource for the gateway. Storage resource is the place to hold all gateway user data: inputs and outputs from computations.<br>
-2. Navigate to Settings → Gateway Resource Profile.
-3. Select a SSH key from the list or generate new one and assign it.
-4. Click: New Storage Preference +.
-5. Select Storage Resource: This is the storage resource for the user files and generally its the same server that holds the Django portal. If the gateway is deployed for you, this part would be taken cared by the SciGaP team. If the gateway is self-deployed select the host name of the server you deployed the gateway.
-6. Login Username: pga (This is the username which uses to ssh to the storage resource)
-7. File System Root Location: /var/www/portals/gateway-user-data/seagrid (The path which stores all user files, input files and output files)
-8. Resource Specific Credential Store Token: Select a token from the list. (Public key of this token need to be added to authorized_keys in your storage resource 'pga' login)
-9. Save.
-
-
-##### <h5 id="GtwyAccess">Managing User Accounts & User Groups</h5><br>
-1. Read: [User Groups](airavata-user-profiles.md)
-2. To manage gateway users access use, Groups from top right-hand dropdown.
-3. Click 'Edit' on the group you want to add users.
-4. Mostly the users are added to Gateway-user group by the gateway admins.
-4. Search for the user account using search text field.
-5. The name entered, will be searched across username, first name, last name and email.
-6. User with the matching search string will be listed in the dropdown.
-8. Select the user account, it will get added in to the list highlighted in green.
-9. By default users are added with Member role.
-10. Using the Groups interface, searching for already added users, deleting existing users and changing their roles are supported.
-
-
-##### <h5 id="Notices">Communication with Gateway Users</h5><br>
-1. Provides a method to notify the gateway user.
-2. When user logs in, a 'Bell' icon will be displayed with the number of unread messages next to Dashboard on top menu bar.
-3. Gateway admin can create these notices with an assigned priority.
-4. navigate to Settings → Manage Notices
-5. Click 'New Notice +'
-6. Provide:
- - Notice Title: Gordon cluster is retiring (A heading for the notice)
- - Notice Message: Gordon cluster is retiring from Dec 31st 2016. Preserve your files now.
- - Publish Date: Select from the provided calendar
- - Expiration Date: Mandatory.
- - Priority: LOW (Default is 'LOW'. Admin can change)
-
-
-
-##### <h5 id="Traffic">Monitor Gateway Traffic</h5><br>
-1. To monitor current gateway experiment and job statuses navigate to Settings → Experiment Statistics.
-2. Gateway admin can view and filter experiments of the gateway using this page.
-3. In experiment statistics page, by default gateway status for last 24 hours will be displayed.
-4. Two buttons, 'Past 24 Hours' and 'Past Week' will group and list the experiments for the selected time.
-5. In order to further filter the experiments use, Filters dropdown.
- - Username: AnneMarie (Gateway username need to be typed in)
- - Application Name: Gaussian (All the application in teh gateway will be listed)
- - Hostname: Comet.sdsc.edu (A drop down will provide all the compute resources to select from)
- - Click 'Get Statistics'
-6. Using the calendar, you can search experiments for a time duration you need.
-7. Once the experiments are filtered and grouped, click on the desired group (Existing experiments groups are 'Total','Created','Running', Completed','Cancelled' and 'Failed').
-8. When you list an experiment group you can select the experiment you want to view using 'View Details'. This will open the experiment Details Summary in a new tab.
diff --git a/docs/user-documentation/airavata-user-profiles.md b/docs/user-documentation/airavata-user-profiles.md
deleted file mode 100644
index 4c96814..0000000
--- a/docs/user-documentation/airavata-user-profiles.md
+++ /dev/null
@@ -1,56 +0,0 @@
-## Apache Airavata User Groups
-
-### What Are Airavata User Groups?
-
-1. Prior to using Airavata, lets identify and understand the user groups available and their features.
-2. Knowing the groups and the features of each, will assist on shaping your gateway user hierarchy.
-3. There are 3 base user groups in Airavata with different set of features at each level.
- - Admin
- - Admin-Read-Only
- - Gateway-User
-
-### Features of each User Group
-
-1. Admin Group
- - Set up gateway Group Resource Profiles.
- - Add gateway storage resource profile.
- - Generate SSH keys for compute and storage resource SSH communications..
- - Add the generated SSH key to group resource profiles.
- - Add the generated SSH keys to authorized_key files in each resource.
- - Create Applications and their deployments in to the gateway.
- - Manage users, add the mto base groups.
-<br><b>NOTE: If user hosts his own gateway; 'Gateway Admin' role will have access to create compute resources and storage resources as well.</b></br><br>
-2. Admin-Read-Only
- - Can view everything in Settings but cannot Add, Edit or Delete any records from dashboard.
- - Can monitor experiments through Experiments Statistics in Experiment statistics.
-<br></br>
-3. Gateway User
- - Create, launch their own experiments in using available applications and compute resources.
- - Monitor progress of experiment execution.
- - Download experiment outputs from experiment summary or from the storage.
- - Upload files in to the storage for future use.
- - Group experiments by creating Projects.
- - Create own SSH keys from Credential store
- - Create Group Resource profiles to use individual HPC allocations for job submission through the gateway.
- - Password reset.
-
-
-### How User Groups Work?
-
-1. Users can belong to one or many user groups.
-2. Two main categories of groups
- - Base groups - Created as default groups in the gateway at gateway deployment
- - User groups - Any user in the gateway can create user groups, and add other gateway users to the group.
-3. Users in group will have one of the three roles. Three roles are:
- - Owner - Person who creates the user group
- - Admin - Person who can add other users in to the group. These users' role cannot be changed by users with admin role.
- - Member - This person can use benefits of the group, but cannot add or remove users from the group.
-4. Only the owner of the group can change users; role.
-5. Adding users to base groups can be done using two interfaces.
- - Settings → Manage Users
- - Top right-hand corner dropdown menu → Groups
-6. Adding users to any other group that you are an admin of or the owner of can be done using
- - Top right-hand corner dropdown menu → Groups
-7. In Manage Users page, users are listed with all the groups they are a member of.
-
-
diff --git a/docs/user-documentation/clone-cancel-share.md b/docs/user-documentation/clone-cancel-share.md
new file mode 100644
index 0000000..e797548
--- /dev/null
+++ b/docs/user-documentation/clone-cancel-share.md
@@ -0,0 +1,42 @@
+## Clone, Cancel & Share your Experiment
+- Available actions on Experiments
+ - <a href= "#clone">Clone</a></br>
+ - <a href= "#share">Share</a></br>
+ - <a href= "#cancel">Cancel</a></br>
+ - <a href= "#edit">Edit</a></br>
+ - <a href= "#launch">Launch</a></br>
+
+
+
+Image: Actions available on Experiment
+##### <h5 id="clone">Clone Experiment</h5>
+1. Cloning an experiment is available from "Experiment Browse" and "Experiment Summary" pages.
+2. Cloning is creating a new experiment to launch a new job from a previous experiment.
+3. Once cloned, user can change the input files or computational resource queue properties and launch the newly cloned experimnet.
+4. A general user can clone its own experiment as well as ones shared by others.
+5. Irrespective of the existing status of the experiment, user can clone and create a new one.
+
+##### <h5 id="share">Share Experiment</h5>
+1. Sharing is available through "Experiment Summary" page.
+2. You can share with an individual or a user group.
+3. When sharing you can specify the permission as READ, WRITE or MANAGE_SHARING.
+4. After you have share, you can change permissions or un-share.
+</br></br>
+
+Image: Share an Experiment
+5. When you share with READ permission, the shared with person/group can view your experiment files, clone your experiment.
+6. When you share with WRITE permission, the shared with person/group can view files, clone yours, launch or cancel your experiment.
+7. With MANAGE_SHARING the shared with person/group can do all above (READ & WRITE capabilities) and share your experiment with other gateway users.
+
+##### <h5 id="cancel">Cancel Experiment</h5>
+1. Canceling an experiment is available from "Experiment Summary" page.
+2. You can ONLY cancel an experiment in "LAUNCHED" or "EXECUTING" state.
+3. Canceling an experiment will cancel job running on the remote computational resource.
+
+##### <h5 id="edit">Edit Experiment</h5>
+1. Can edit experiments in "CREATED" state.
+2. Editing is available from "Experiment Summary" page.
+
+##### <h5 id="launch">Launch Experiment</h5>
+1. Launching an experiment is only for experiments in "CREATED" state and available from "Experiment Summary" page.
+
diff --git a/docs/user-documentation/create-experiment-launch-job.md b/docs/user-documentation/create-experiment-launch-job.md
new file mode 100644
index 0000000..303d19a
--- /dev/null
+++ b/docs/user-documentation/create-experiment-launch-job.md
@@ -0,0 +1,31 @@
+## Create Experiments & Launch Jobs
+- To create "Experiments" and launch "Jobs" you need to know your
+ - <a href= "#workspace">Workspace</a></br>
+ - <a href= "#createexp">How to Create Experiments</a></br>
+ - <a href= "#launchjob">How to Launch Jobs</a></br>
+
+
+##### <h5 id="workspace">Workspace</h5>
+1. "Workspace" is your central interface after login.
+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.
+ TIP: Mark your "Favorites" using the star on the tile.
+5. On your right, you would see your latest computational experiments and their statuses.
+
+Image: Portal Workspace
+
+
+##### <h5 id="Local">Create Experiment</h5>
+1. The 'Experiment' is what you create using an existing Application in the workspace to launch a job in an external computational resource.
+2. Select an application from the workspace and you would then be able to create an experiment providing the inputs and computational resource queue properties.
+3. After providing the required inputs and creating the experiment either "Save & Launch" or "Save" to launch later.
+4. An experiment may have one-to-one or one-to-many relationship with computation jobs launched at remote resources.
+
+Image: Create Experiment Page
+
+
+##### <h5 id="Local">Launch Jobs</h5>
+1. Launching a job from the gateway results in creating a job script, generating a Job Name, creating a working directory for the job in remote computational resource and submitting a job.
+2. Saving and launching a created experiments will submit a job.
+3. Once the job is submitted the remote resource will response back with a job ID.
diff --git a/docs/user-documentation/create-groups.md b/docs/user-documentation/create-groups.md
new file mode 100644
index 0000000..cac52b0
--- /dev/null
+++ b/docs/user-documentation/create-groups.md
@@ -0,0 +1,25 @@
+##Create User Groups
+
+- With Groups functionality;
+ - <a href= "#viewgroups">View all Groups</a></br>
+ - <a href= "#creategroup">Create Groups</a></br>
+
+##### <h5 id="viewgroups">View User Groups</h5>
+1. In Groups page, you can view all the groups available in the gateway.
+2. If you are an admin of a particular group, you would be able to edit and add new users to the group.
+</br></br>
+
+
+Image: View User Groups
+
+
+##### <h5 id="creategroup">Create User Groups</h5>
+1. Create your own groups from "Groups" interface.
+2. You can add other gateway users to your group and give them either 'Member' role or 'Admin' role.
+3. Members are just in your group and when you share your experiments or computational allocation with the group they can access them.
+4. Admin role will enable those users to add other users to your group.
+5. Only the group "Owner" can change the roles of other users.
+</br></br>
+
+
+Image: Create User Group
\ No newline at end of file
diff --git a/docs/user-documentation/django-documenation.md b/docs/user-documentation/django-documenation.md
deleted file mode 100644
index e69de29..0000000
diff --git a/docs/user-documentation/monitor-experiment.md b/docs/user-documentation/monitor-experiment.md
new file mode 100644
index 0000000..53a62d6
--- /dev/null
+++ b/docs/user-documentation/monitor-experiment.md
@@ -0,0 +1,27 @@
+## Monitor Experiments
+- In the gateway after launching an experiment, you can monitor
+ - <a href= "#monexp">Experiment Status</a></br>
+ - <a href= "#monjob">Job Status</a></br>
+
+##### <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. 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.
+ TIP: Mark your "Favorites" using the star on the tile.
+5. On your right, you would see your latest computational experiments and their statuses.
+
+Image: Browse Experiments
+
+
+##### <h5 id="monjob">Monitor Jobs</h5>
+1. The 'Experiment' is what you create using an existing Application in the workspace to launch a job in an external computational resource.
+2. Select an application from the workspace and you would then be able to create an experiment providing the inputs and computational resource queue properties.
+3. After providing the required inputs and creating the experiment either "Save & Launch" or "Save" to launch later.
+4. An experiment may have one-to-one or one-to-many relationship with computation jobs launched at remote resources.
+
+Image: Experiment Summary with Active Job
+</br></br></br>
+ 
+Image: Experiment Summary with Completed Job & Outputs
\ No newline at end of file
diff --git a/docs/user-documentation/cms-tutorials.md b/docs/user-documentation/other-features.md
similarity index 100%
rename from docs/user-documentation/cms-tutorials.md
rename to docs/user-documentation/other-features.md
diff --git a/docs/user-documentation/personal-allocation.md b/docs/user-documentation/personal-allocation.md
new file mode 100644
index 0000000..3059075
--- /dev/null
+++ b/docs/user-documentation/personal-allocation.md
@@ -0,0 +1,26 @@
+##Use Your Allocation for Jobs
+
+- The gateway generally has allocations added by the gateway admin. This allocation is for all the gateway users to use through a single login in the remote computational resource.
+- This single login is known as either "Group login" or a "Community Login".
+- Apart fom using the above allocation and login, you can use your own allocation and login for your own jobs.
+- This could be on your campus resource or on a national resource such as an XSEDE resource.
+
+##### <h5 id="viewgroups">View User Groups</h5>
+1. In Groups page, you can view all the groups available in the gateway.
+2. If you are an admin of a particular group, you would be able to edit and add new users to the group.
+</br></br>
+
+
+Image: View User Groups
+
+
+##### <h5 id="creategroup">Create User Groups</h5>
+1. Create your own groups from "Groups" interface.
+2. You can add other gateway users to your group and give them either 'Member' role or 'Admin' role.
+3. Members are just in your group and when you share your experiments or computational allocation with the group they can access them.
+4. Admin role will enable those users to add other users to your group.
+5. Only the group "Owner" can change the roles of other users.
+</br></br>
+
+
+Image: Create User Group
\ No newline at end of file
diff --git a/docs/user-documentation/quick-start.md b/docs/user-documentation/quick-start.md
new file mode 100644
index 0000000..5ae9611
--- /dev/null
+++ b/docs/user-documentation/quick-start.md
@@ -0,0 +1,25 @@
+## Quick Start Steps
+1. Create your account in the gateway portal either using your existing institutional login through CILogon OR by creating a local account.
+<br>For more information refer: <a href="/user-documentation/account-creation" target="_blank">Account Creation</a><br>
+</br>
+
+Image: Create Account Page
+
+2. Login to the gateway portal, in 'Workspace' make sure the applications/tools you plan to use are enabled; not grayed out.
+<br></br>
+
+3. Create experiments under the applications/tools you plan to use and launch jobs in remote computational resources.
+ <br>For more information refer: <a href="/user-documentation/create-experiment-launch-job" target="_blank">Create Experiment & Launch Jobs</a><br>
+<br></br>
+
+Image: Create Experiment Page
+
+4. After launching your job, you can monitor them until completion. You can add your email to receive emails upon notification.
+ <br>For more information refer: <a href="/user-documentation/monitor-experiment" target="_blank">Monitor Experiments & Jobs</a><br>
+<br></br>
+
+
+5.
+
+
+
diff --git a/docs/user-documentation/supported-applications.md b/docs/user-documentation/supported-applications.md
index 2a7c22b..03f0cd0 100644
--- a/docs/user-documentation/supported-applications.md
+++ b/docs/user-documentation/supported-applications.md
@@ -40,4 +40,4 @@ Inputs for all applications currently available in Airavata can be found <a href
### Application Configuration
-For sample configurations please refer [Admin Tutorials](admin-tutorials.md)
\ No newline at end of file
+For sample configurations please refer [Admin Tutorials](monitor-experiment.md)
\ No newline at end of file
diff --git a/docs/user-documentation/user-tutorials.md b/docs/user-documentation/user-tutorials.md
deleted file mode 100644
index eae3c20..0000000
--- a/docs/user-documentation/user-tutorials.md
+++ /dev/null
@@ -1,3 +0,0 @@
-
-###Basic tutorials for gateway end users and admin users.
-1. <a href="https://cwiki.apache.org/confluence/display/AIRAVATA/Django+Portal+for+Airavata+-+End-User+Guide" target="_blank">Django Portal End User Tutorial</a> <br>
\ No newline at end of file
diff --git a/mkdocs.yml b/mkdocs.yml
index 7b0e96d..73197d6 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -1,43 +1,22 @@
-site_name: Apache Airavata User Docs
+site_name: Django Portal - General User Docs
site_url: https://airavata.apache.org/
-site_description: Apache Airavata Documentation
+site_description: Apache Airavata Django Portal General User Documentation
-repo_url: https://github.com/apache/airavata-docs
+repo_url: https://github.com/apache/airavata-user-docs
docs_dir: docs
nav:
- Home: 'index.md'
-- User Documentation:
- - Gateway User Tutorials: 'user-documentation/user-tutorials.md'
- - Gateway Admin Tutorials: 'user-documentation/admin-tutorials.md'
- - Gateway Theme Implemenetation: 'user-documentation/cms-tutorials.md'
- - Advance Application Configuration: 'user-documentation/JSON-tutorials.md'
- - Apache Airavata User Groups: 'user-documentation/airavata-user-profiles.md'
-# - Application Support: 'user-documentation/supported-applications.md'
-#- System Configuration:
-# - Keycloak Configuration: 'configuration/keycloak-configuration.md'
-# - Django Configuration: 'configuration/pga-configuration.md'
-# - Django FAQ: 'maintenance/pga-maintenance.md'
-#- Installation:
-# - Apache Airavata Installation: 'installation/airavata-installation.md'
-# - Django Installation: 'installation/pga-installation.md'
-# - Apache Airavata Server Properties: 'installation/airavata-server-properties.md'
-# - Code Update:
-# - Code Update:
-# - Apache Airavata Update: 'maintenance/code-update/airavata-update.md'
-# - PGA Update: 'maintenance/code-update/pga-update.md'
-#- Technical Documentation:
-# - Apache Airavata API: 'technical-documentation/airavata-api.md'
-# - Helix Job Management: 'technical-documentation/helix-job-management.md'
-# - Django Portal: 'technical-documentation/django-portal.md'
-# - Sharing Documentation:
-# - Introduction: 'technical-documentation/sharing-documentation/introduction.md'
-# - API Overview: 'technical-documentation/sharing-documentation/api-overview.md'
-# - Sharing CPI: 'technical-documentation/sharing-documentation/sharing-cpi.md'
-# - Sharing Models: 'technical-documentation/sharing-documentation/sharing-models.md'
-#- FAQ: 'faq.md'
-#- Previous Releses: 'previous-releases.md'
+- General:
+ - Quick Start: 'user-documentation/quick-start.md'
+ - Create User Account: 'user-documentation/account-creation.md'
+ - Create Experiment & Launch Job: 'user-documentation/create-experiment-launch-job.md'
+ - Monitor Your Experiment: 'user-documentation/monitor-experiment.md'
+ - Clone, Cancel and Share: 'user-documentation/clone-cancel-share.md'
+ - Create Your Groups: 'user-documentation/create-groups.md'
+ - Use Your Own HPC Account: 'user-documentation/personal-allocation.md'
+ - Other Features: 'user-documentation/other-features.md'
- Contact Us: 'contact-us.md'
theme: readthedocs