Skip to content

Latest commit

 

History

History
84 lines (63 loc) · 5.17 KB

share.md

File metadata and controls

84 lines (63 loc) · 5.17 KB
Raw

Sharing and Publishing Projects

There are two ways in which your work on the online platform can be accessed by others. You may either share an instance of your Project with other member(s) of an organization, or publish the Project as a Tutorial for other members to copy.

Organization

An organization is any group of sim4life.io users that can share Projects. To see which organizations you are a part of, go to Organizations through your Profile button at the top right corner of the user interface. This will display all organizations you belong to and you may see the members of each organization by clicking on it. There are four different types of members in an organization:

  1. User
    • Can not see the members of other organizations
    • Can not share content with the organization
  2. Member
    • Has access to shared content of the organization
    • Can share content with the organization
  3. Manager
    • Has Member privileges
    • Can add or remove Members
    • Can promote Members to Managers
  4. Administrator
    • Has Manager privileges
    • Can edit the organization’s description
    • Can delete the organization

To create a new organization, click the + New Organization button and add a title and description for new organization. You can then add members to this particular organization by entering each new member's email address and then clicking Add. Note that you may only add members that are already registered sim4life.io users. You may change each member's privileges by clicking on that member's name.

Generating new organizaton.

Sharing a Project

Sharing a Project instance with other users allows collaboration on the same pipeline and code. When one member of the shared users is editing a Project, the Project is locked for the others. When that user finishes and returns to their Dashboard, the changes will be updated when another member accesses the Project.

To share a Project:

  1. Access the Project's options from the Dashboard by clicking on the three dot button on the upper right hand corner of the Project card. Choose the Share option. A window should appear. This can also be accessed by clicking on the Project card which shows the Project Details. From there, the user can switch to the Share icon in the left side of the panel. This will display the same sharing window.
  2. In the Sharing tab, click on the Add Editors to see the list of users you may share with. Choose one or more people/organizations to share your Project with, and then click the Share button.
  3. The Project will then appear in the PROJECTS tab of the user(s) you have shared with.

There are three types of roles for projects :

  1. Viewer
    • Can open the project
    • Can not modify the project
  2. Editor
    • Can open the project
    • Can modify the project
    • Can share the project with other members
    • Can not delete the project
  3. Owner
    • Can open the project
    • Can modify the project
    • Can share the project with other members
    • Can delete the project

Publishing a Project as a Tutorial

Publishing a Project as a Tutorial will save the state of the Project at the current moment and it will appear as a Tutorial Project in the TUTORIALS tab of the Dashboard. Any changes made to the original Project after publishing as a Tutorial will not change the Tutorial. Clicking on the Tutorial Project in the TUTORIALS tab will create a copy of the contents of the Tutorial accessible in your PROJECTS tab. Any changes you make to this new Project will not affect the original Tutorial.

To publish your Project as a Tutorial:

  1. Click on the Project card and open Project Details.
  2. Switch to the Save as Tutorial tab in the left panel as shown in the figure below
  3. Set the access rights of the Tutorial. You may make the Tutorial accessible to only yourself (Private) or members of organizations. If you choose Organizations, you will be able to select from the list of organizations that you are a part of.
  4. You may also choose to publish the Tutorial with the data inside (for example, if you have any files saved in a JupyterLab inside the Project). To publish with data, make sure the "Publish with data" field is checked.
  5. Click the Publish button at the bottom right hand corner.
  6. The Tutorial will now appear as a Tutorial Project in your TUTORIALS tab. If you have chosen to share the Tutorial with members of an organization, others in that same organization will also see the Project in their respective TUTORIALS tabs.