Skip to content

Follow-up from "Resolve "HPC Workspace improvements""

The following discussions from !31 (merged) should be addressed:

  • @lsaloio started a discussion:

    [HPC Workspace](https://github.com/holgerBerger/hpc-workspace) that allows you to
    create and manage scratch space in a sustainable fashion. The following instructions describe how to create workspaces and manage them with some key features.
  • @lsaloio started a discussion:

    Use the `ws_allocate` command to create a workspace. There are many different options for creating a workspace.
    To view all of the options, run `ws_allocate -h`.
  • @lsaloio started a discussion:

    Consider getting rid of these headings all together since I don't think they're entirely necessary -- you can just use the "## Create a workspace" heading for this section, and then clarify the specifics of the example you are showing. For example:

    The following code sample shows how to create a workspace for a single user with a given number of days. The maximum duration for a workspace is 30 days.
    
    {{< callout note >}}
    When following all code examples in this guide, remember to replace `username` with an actual Unity username.
    {{< /callout >}}
  • @lsaloio started a discussion:

    After running the `ws_allocate` command to create a workspace, the following code pops up to show that the directory was created.
  • @lsaloio started a discussion:

    Since we got rid of the other headings and the only one before this is "## Creating a workspace", this heading can be changed to a level three heading. This should improve the document's readability. You'll see me adjusting the headings like this throughout this review.

    ### Send an email reminder before workspace expiration
  • @lsaloio started a discussion:

    Use the `-m` option to specify an email address that you want to be notified before the
    workspace expires.
  • @lsaloio started a discussion:

    This option also requires you to specify the number of days before expiration using the `-r` option.
  • @lsaloio started a discussion:

    Just add "For example:" before code block. Added a line in this suggestion since there's text in the line above this... not sure if that works or not so you might have to adjust spacing.

    
    For example:
  • @lsaloio started a discussion:

    Consider adding a higher-level heading, "## Manage workspaces," that will hold all of the instructions having to do with managing workspaces (listing workspaces, releasing workspaces. and extending workspaces). I made a comment below suggesting that the "### Create a group workspace" section should be moved up into the "## Create a workspace" section.

    
    ## Manage workspaces
  • @lsaloio started a discussion:

    Consider moving this section ("Create a group workspace") up in the document, after "### Send an email reminder before workspace expiration" which is within the "## Create a workspace" section. I recommend this since the "Create a group workspace" section has to do with creating a workspace.

    So, the order would be:

    • "## Create a workspace"
    • "### Send an email reminder before workspace expiration"
    • "### Create a shared workspace"
  • @lsaloio started a discussion: (+1 comment)

    Consider moving this section after ## Manage workspaces / before ### List workspaces.

    So, the order would be:

    • "## Manage workspaces"
    • "### Share a workspace with another user"
    • "### List workspaces"
    • "### Release workspace"
    • "### Extend workspace"
  • @lsaloio started a discussion:

    ### List workspaces
  • @lsaloio started a discussion:

    Use the `ws_list` command to list your workspaces.
    
    For example:
  • @lsaloio started a discussion:

    ### Release workspace
  • @lsaloio started a discussion:

    Use the `ws_release` command to release a workspace once you are done with it. Releasing a workspace means that the ID can be reused, and the directory is no longer accessible.
    
    For example:
  • @lsaloio started a discussion:

    ### Extend workspace
  • @lsaloio started a discussion:

    Use `ws_list` to see the available number of extensions.
  • @lsaloio started a discussion:

    The following code sample shows how to create a workspace and extend it for 30 days.
  • @lsaloio started a discussion:

    ### Create a shared workspace
  • @lsaloio started a discussion:

    The HPC Workspace utility allows you to create **shared** workspaces which can be useful for collaborating on a project.
    To create a shared workspace, all members must be members of a common group, such as the members of a particular PI group.
  • @lsaloio started a discussion:

    The following code sample shows how to create a workspace that can be shared with a particular PI group.
  • @lsaloio started a discussion:

    After creating the shared workspace, the following code pops up to show that the directory was created with group sharing permissions.
  • @lsaloio started a discussion:

    ## Create a workspace
Edited by Lauren Saloio