Commit 5fe8748a authored by Ethan Gates's avatar Ethan Gates

resources page updates

more detail on Explore and My Resources page

also Emulation Project, Slide UI details
parent d4afff4c
.. Details pages
.. _details:
Details Pages
===============
Environment Details
---------------------
Software Details
--------------------
Content Results
-------------------
.. Emulation Access interface
.. _emulation_access:
Emulation Access Interface
=============================
.. Emulation Project
.. _emulation-project:
Emulation Project
===================
The Emulation Project menu allows EaaSI users the opportunity to create new Environments from "scratch" using existing Software and emulators in their node.
.. note::
For the EaaSI v2020.03 release, "Emulation Project" essentially replaces the "Create Environment" menu and workflow from the :ref:`legacy_ui`. Future updates will expand the feature-set of the Emulation Project for a more flexible "mix-and-match" type approach to creating new Environments.
To create a new Base Environment, two conditions must be met:
1. The node must have available system hardware templates. Templates are made available either by:
- saving Remote environments from other nodes in the Network to your node (the emulator and template used to create that Environment will then automatically become available in the local node)
- importing emulator images (see :ref:`Managing Emulators <managing_emulators>`)
2. An appropriate, bootable Software resource (e.g. an operating system installation disk) - that is, any Software resource that has been marked "IS AN OPERATING SYSTEM"
On the Emulation Project menu, the user must first select an option from the Template menu (to select an emulator and default configuration).
Next, specify a disk size (in MB) for the Environment's system drive. The EaaSI platform will automatically create a blank disk image/virtual hard drive on which to install the operating system, of the specified size.
.. note::
The blank disk iamge will be created using QEMU's "qcow2" file format.
Select a bootable operating system disk using the "Install from Object" dropdown menu (the dropdown menu should display all Software resources in the node that have been marked "IS AN OPERATING SYSTEM").
If desired, the user can edit the Config field to tweak the settings passed to the underlying emulator. The Config field is filled in automatically by the selected Template, but can be freely edited. Please consult the relevant :ref:`emulator's <emulators>` documentation to change Config settings appropriately (or contact the EaaSI Tech Talk list or the Software Preservation Analyst for assistance).
An example Emulation Project below, using the "Generic 90s PC" template provided by the "eaas/qemu-eaas:2-12" emulator image, a bootable MS-DOS 6.22 Software resource (Floppy-type set), and a 1 GB virtual hard drive:
.. image:: ../images/ms-dos622.png
.. warning::
"Enable KVM", if the EaaSI deployment is properly configured, allows for the EaaSI platform to virtualize, rather than emulate, compatible x86 operating system Environments. This will accelerate and improve Environment use if compatible, but may result in errors if incompatible. It is recommended for recent (~2005-present) Linux systems or Windows XP and newer. Please consult KVM's `documentation <https://www.linux-kvm.org/page/Main_Page>`_ to investigate whether your desired "guest" OS is compatible.
Clicking "Run" will start an emulation session in the Emulation Access interface with the selected settings. From this point, the user can install and configure the operating system software, Change Resource Media, and Save the Environment to create a new Private Environment. See :ref:`emulation_access`.
......@@ -4,3 +4,80 @@
Explore Resources
====================
The "Explore Resources" page is the EaaSI platform's main portal for discovery. From this overview, users can find resources saved in their node or available across the EaaSI Network.
Each resource card has visual tags to quickly display relevant information like the Resource Type (Environment, Software, or Content) and Network status (Private, Saved, Remote).
.. image:: ../images/explore_resources.png
The Explore Resources page will display the first 10 resources within each resource category - Environments (which includes both Base and Content Environments), Software and Content. If there are more than 10 resources available in any given category, users can use the "Refine Your Results" sidebar to more narrowly browse, or use the search bar at the top of the screen to find a particular resource.
.. note::
The "Search resources" bar currently only performs a free-text search based on resource names. Advanced search based on particular metadata fields (Description, Operating System, etc.) is under development with the implementation of the EaaSI metadata application profile.
Any resource on the Explore Resources page can be bookmarked by the logged-in user by clicking the bookmark icon at the top right corner of the resource card:
.. image:: ../images/bookmark.png
A bookmarked resource will then be visible on the :ref:`my_resources` page for quick reference/use later.
Environment Results
----------------------
.. image:: ../images/refine_results_envs.png
Environment resources can be refined by Network Status, i.e. whether that Environment is:
* **Remote** (available at a synced node in the Network but must be replicated to the local node
before it can be used)
* **Saved** (published to the Network and already replicated and available in the user's local node)
* **Private** (only available to users in the local node, not available to the Network)
By default, any new Environments, (including derivatives or revisions of Saved Environments) are "Private". To publish a Private environment to the Network, see :ref:`publishing`.
Environment resource cards also contain two additional tags: "Base" and "Content".
* **Content** indicates that the Environment is a Content Environment, meaning it has been
associated with a particular Content resource. Content resources are exclusively available to the local node, and Content Environment *can not* be published to the Network. They will always be "Private".
* **Base** indicates any Environment that is not associated with Content. It can be further configured, associated with Software and/or Content resources, or published to the Network to benefit users at other nodes.
Software Results
------------------
.. image:: ../images/refine_results_software.png
Software resource results can only be minimally sorted and refined until implementation of the EaaSI metadata application profile.
.. note::
In the screenshot above, the "Source Location" field refers to an experimental implementation of sharing Software resources between nodes in the EaaSI Network (mimicking the publishing functionality available with Environments). This feature is not functional in EaaSI v2020.03 and can be ignored by users.
Content Results
-----------------
.. image:: ../images/content_results.png
Content results can only be minimally sorted and refined until implementation of the EaaSI metadata application profile.
Slide Menu
-------------
Clicking on the top left corner of any resource card will activate a Slide Menu containing contextual "Actions" for that resource:
.. image:: ../images/slide_ui.gif
* **"View Details"** will take the user to that resource's Details page (same as clicking on the resource name/title)
* **"Run in Emulator"** (Private and Saved Environment resources only) opens an Environment in the Emulation Access interface
* **"Bookmark This Resource"** adds the resource to bookmarks on the :ref:`my_resources` page (same action as clicking the bookmark icon)
* **"Add to Emulation Project"** (feature under development, not available in v2020.03)
* **"Add Software"** (Private and Saved Environment resources only) allows the user to select a Software resource from a dropdown menu, then opens that Environment in the Emulation Access interface with the Software resource attached
* **"Save to My Node"** (Remote Environment resources only) copies an Environment published from another node in the Network to the user's node - the Environment tag will change from Remote to Saved
* **"Publish to Network"** (Private Environment resources only) makes an Environment available for users at other nodes to save to their node - the Environment tag will change from Private to Saved
* **"Delete"** (Private Environment and Content resources only) removes the selected resource from the node
The Slide Menu will also display any currently running background processes in the node (e.g. importing emulators, Saving resources to the node, etc.)
......@@ -4,3 +4,16 @@
My Resources
=============
The My Resources page is unique for every EaaSI user account. It tracks and displays bookmarked and imported resources by the logged-in user.
As on the :ref:`explore` page, you can use the Refine Your Results page to sort quickly through either My Bookmarks or Imported Resources based on Resource Type and Network Status.
.. image:: ../images/my_resources.png
By default, the My Resources page will open on the "My Bookmarks" tab, but users can also navigate to the "Imported Resources" tab to view and track Software and Content resources that they have individually imported to the node:
.. image:: ../images/imported_resources.png
.. note::
Coming soon! Environment resources will be tracked and associated with the individual user who created them within the EaaSI platform - allowing for more granular quality control by Admin/Manager-level users and for users to further track their own work using the "My Contributions" tab.
......@@ -8,7 +8,7 @@ Publishing and Replicating Resources
What resources can be published to the network?
===============================================
Environments are the only type of resource that can be published and shared between EaaSI nodes. (Software can/must be
Environments are the only type of resource that can currently be published and shared between EaaSI nodes. (Software can/must be
shared by first installing it into an Environment and then publishing the Environment)
Also, this does not apply to Content Environments.:term:`Content` and associated Content Environments are assumed to be collection items, unique to each
......@@ -29,7 +29,7 @@ What resources *should* be published?
Nodes and users are advised to use the beta testing period to consider how to design and enforce local workflows for
publishing resources, given these technical restrictions.
When selecting Base and Software Environments to share with the rest of the network, EaaSI users and admins can
When selecting Environments to share with the rest of the network, EaaSI users and admins can
consider questions posed by the `Code of Best Practices in Fair Use for Software Preservation <https://www.arl.org/storage/documents/publications/2018.09.24_softwarepreservationcode.pdf>`_:
- Did you lawfully acquire your copy of the software included in the environment?
......@@ -42,16 +42,23 @@ type of content that might be appropriate to share, but this will also be an ong
the network.
How to publish Environments
=================================
tktktktktktk
In a selected Private Environment's Action menu (either in the Slide Menu on the Explore/My Resources pages, or the Actions menu in the Environment's Details page), select "Publish to Network":
.. image:: ../images/publish_slide_ui.png
.. image:: ../images/publish_details.png
.. _replication:
How to replicate Environments to a local node
================================================
How to save published Environments to a local node
====================================================
In a selected Remote Environment's Action menu (either in the Slide Menu on the Explore/My Resources pages, or the Actions menu in the Environment's Details page), select "Saved to My Node":
.. image:: ../images/save_slide_ui.png
tktktktktktk
.. image:: ../images/save_details.png
......@@ -21,9 +21,12 @@ EaaSI User Handbook
guide/dashboard
guide/explore-resources
guide/my-resources
guide/details
guide/emulation_project
guide/emulation_access
guide/import-resource
guide/publishing
guide/administration
guide/publishing
.. toctree::
:maxdepth: 1
......
......@@ -33,4 +33,4 @@ SPN
===
For more information about the EaaSI network and our full program of work, please visit our project site on the
`Software Preservation Network <https://softwarepreservationnetwork.org/eaasi>`_!
`Software Preservation Network <https://www.softwarepreservationnetwork.org/projects/emulation-as-a-service-infrastructure>`_!
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment