Merge branch 'GodloveD-merge-master-into-2.4'

Author: vsoch

_config.yml

@@ -21,6 +21,7 @@ google_analytics: "UA-84672381-1" # Google Analytics code
 twitter_username:     SingularityApp
 github_username:      singularityware
 repo: "https://github.com/singularityware/singularity" # The main repo, should not end with slash
+singularity_version: "2.4"
 
 # Exclude
 # these are the files and directories that jekyll will exclude from the build

_data/sidebars/admin_docs.yml

@@ -22,6 +22,10 @@ entries:
       url: /docs-config
       output: web, pdf
 
+    - title: Container Checks
+      url: /docs-admin-checks
+      output: web, pdf
+
     - title: Troubleshooting
       url: /docs-troubleshooting
       output: web, pdf

_data/sidebars/main_sidebar.yml

@@ -47,6 +47,9 @@ entries:
       url: /install-windows
       output: web, pdf
 
+    - title: Host a Singularity Registry
+      url: /singularity-registry
+      output: web, pdf
 
   - title: Contributing
     output: web, pdf
@@ -106,4 +109,6 @@ entries:
       url: /admin-guide
       output: web, pdf
 
-
+    - title: Archive
+      url: /archive
+      output: web, pdf

_data/sidebars/user_docs.yml

@@ -15,36 +15,48 @@ entries:
       url: /user-guide
       output: web, pdf
 
-    - title: Quick Start Installation
-      url: /docs-quick-start-installation
+    - title: Installation
+      url: /docs-installation
       output: web, pdf
 
-    - title: Create an Image
-      url: /create-image
+    - title: Quick Start
+      url: /quickstart
       output: web, pdf
 
-    - title: Bootstrap an Image
-      url: /bootstrap-image
+    - title: Build a Container
+      url: /docs-build-container
       output: web, pdf
 
-    - title: Adding Content
-      url: /image-content
+    - title: Container Recipes
+      url: /docs-recipes
       output: web, pdf
 
-    - title: User Control
-      url: /user-control
+    - title: Singularity Flow
+      url: /docs-flow
       output: web, pdf
 
     - title: Bind Paths and Mounts
       url: /docs-mount
       output: web, pdf
 
+    - title: Persistent Overlays
+      url: /docs-overlay
+      output: web, pdf
+
+    - title: Running Services
+      url: /docs-instances
+      output: web, pdf
+
+    - title: Container Checks
+      url: /docs-user-checks
+      output: web, pdf
+
     - title: Environment and Metadata
       url: /docs-environment-metadata
       output: web, pdf
 
-    - title: Change an Existing Container
-      url: /docs-changing-containers
+    - title: Reproducible SCI-F Apps
+      url: /docs-scif-apps
       output: web, pdf
 
     - title: Singularity and Docker
@@ -63,22 +75,14 @@ entries:
       url: /docs-usage
       output: web, pdf
 
-    - title: bootstrap
-      url: /docs-bootstrap
+    - title: build
+      url: /docs-build
       output: web, pdf
 
     - title: exec
       url: /docs-exec
       output: web, pdf
 
-    - title: export
-      url: /docs-export
-      output: web, pdf
-
-    - title: import
-      url: /docs-import
-      output: web, pdf
-
     - title: inspect
       url: /docs-inspect
       output: web, pdf
@@ -94,3 +98,49 @@ entries:
     - title: shell
       url: /docs-shell
       output: web, pdf
+
+
+  - title: Image Command Group
+    output: web, pdf
+    folderitems:
+
+    - title: image.export
+      url: /docs-export
+      output: web, pdf
+
+    - title: image.expand
+      url: /docs-expand
+      output: web, pdf
+
+    - title: image.import
+      url: /docs-import
+      output: web, pdf
+
+    - title: image.create
+      url: /docs-create
+      output: web, pdf
+
+  - title: Instance Command Group 
+    output: web, pdf
+    folderitems:
+
+    - title: instance.start
+      url: /docs-instance-start
+      output: web, pdf
+
+    - title: instance.list
+      url: /docs-instance-list
+      output: web, pdf
+
+    - title: instance.stop
+      url: /docs-instance-stop
+      output: web, pdf
+
+  - title: Deprecated
+    output: web, pdf
+    folderitems:
+
+    - title: bootstrap
+      url: /docs-bootstrap
+      output: web, pdf
+

_includes/asciicast-custom.html

@@ -1,5 +1,5 @@
 <button style='color:white;margin-top:5px' class="btn btn-primary btn-lg asciinema-button" id="{{ include.title | replace:' ','-' }}">Show Video Tutorial</button>
-<div class="hidden" id="asciinema-{{ include.title | replace:' ','-' }}">
+<div class="hidden" id="asciinema-{{ include.uid }}">
     <asciinema-player 
         src="assets/asciicast/{{include.source}}" 
         poster="data:text/plain,{{include.title}}" 

_includes/asciicast.html

@@ -1,5 +1,5 @@
-<button style='color:white;margin-top:5px' class="btn btn-primary btn-lg asciinema-button" id="{{ include.title | replace:' ','-' }}">Show Video Tutorial</button>
-<div class="hidden" id="asciinema-{{ include.title | replace:' ','-' }}">
+<button style='color:white;margin-top:5px' class="btn btn-primary btn-lg asciinema-button" data-id="asciinema-{{ include.uid }}">Show Video Tutorial</button>
+<div class="hidden" id="asciinema-{{ include.uid }}">
     <asciinema-player 
         src="assets/asciicast/{{include.source}}" 
         poster="data:text/plain,{{include.title}}" 

_includes/asciinema.html

@@ -5,8 +5,8 @@
 <script>
 $( document ).ready(function() {
     $(".asciinema-button").click(function(){
-        var asciinemaVideo = "#asciinema-" + $(this).attr('id');
-
+        console.log('rawwwr!')
+        var asciinemaVideo = "#" + $(this).attr('data-id');
         if ($(asciinemaVideo).hasClass('hidden')){
             $(asciinemaVideo).removeClass('hidden');
             $(this).text('Hide Tutorial')

_includes/sidebar.html

@@ -1,10 +1,11 @@
 {% include custom/sidebarconfigs.html %}
 
-{% if site.logo %}
-<div class="shiny"><a href="\"><figure><img src="{{ site.logo }}" class="sidebar-logo"/></figure></a></div>
-{% endif %}
-
 <ul id="mysidebar" class="nav">
+
+    {% if site.logo %}
+    <div class="shiny"><a href="\"><figure><img src="{{ site.logo }}" class="sidebar-logo"/></figure></a></div>
+    {% endif %}
+
     <li class="sidebarTitle">{{sidebar[0].title}}</li>
     {% for entry in sidebar %}
     {% for folder in entry.folders %}

_layouts/page.html

@@ -4,6 +4,8 @@
 
 <div class="post-header">
    <h1 class="post-title-main">{{ page.title }}</h1>
+   <small style="color: #666; margin-top:50px; font-variant:italic">These docs are for Singularity Version {{ site.singularity_version }}. For older versions, see our <a class="no-after" 
+                                                               href="https://singularityware.github.io/archive">archive</a></small>
 </div>
 
 {% if page.simple_map == true %}

_posts/releases/2017-10-02-release-2.4.md

@@ -0,0 +1,55 @@
+---
+title:  "Singularity 2.4 Release"
+category: releases
+permalink: "release-2-4"
+version: "2.4"
+---
+
+Singularity 2.4 is released, and here are the important notes for you to know about!
+
+<img src="/assets/img/posts/releases/singularity-egg-easy.png">
+
+
+**Singularity Build**
+Building an image is now more intuitive with the introduction of our `build` command. You don't need to worry about using `create`, or `bootstrap`, you just build. It looks like this:
+
+```
+sudo singularity build container.simg Singularity
+```
+
+If you are tired of needing to estimate your image size, that issue goes away with build. The default format for a Singularity image base is now a smaller, compressed file format called **SquashFS**.  This format is also a much better fit for reproducible containers, as it is immutable. For more details, see our [build](/docs-build-container) documentation.
+
+**Build Bases**
+We originally supported just using an existing distribution package or docker as a base for building images. With 2.4, we have extended that set to include another Singularity image (`localimage`), or a Singularity Hub or Registry image (`shub`).
+
+**Instance Support**
+Singularity now has support for instances, which means services! Images instances can be started, stopped, and listed. Along with instances comes **Network Namespace Isolation**. We are excited to see the kinds of use cases that this will afford for our users. 
+
+**Singularity Registry**
+If you want to host your own Registry, we listened and you are in luck! Singularity <a href="https://www.github.com/singularityhub/sregistry">Registry</a> is ready for your use, along with a <a href="https://singularityhub.github.io/containers">portal</a> for you to "register your registry" to make it easier to share your images. Singularity Hub, along with improved building and updated builders, will follow this release.
+
+**Internal Modularity**
+This release includes support for the <a href="/docs-apps">Standard Container Integration Format (SCI-F)</a> that makes it easy for you to produce single, internally modular and programmatically discoverage containers. More information is provided on it's <a href="https://containers-ftw.github.io/SCI-F/">main site</a>.
+
+**Better Documentation**
+We've added an entire page on the different customizations you can do to the [build environment](/build-environment), including changing the cache and specifying credentials for Docker. We now also have new sidebars for the Image and Instances command groups.
+
+
+**Deprecated**
+We are deprecating the original `create` command to be replaced with `image.create`, along with `bootstrap` in favor with build. These commands will still work for 2.4, however we recommend you start testing the updated ones.
+
+In addition, here are some tiny changes for your information!
+
+- Persistent Overlay
+- Container checks
+- Tests for instance support
+- Wrapper for create
+- Group instance commands
+- Group image commands
+- Bash completion updates
+
+For the full release announcement and downloads, please see <a target="_blank" href="https://github.com/singularityware/singularity/releases/tag/2.4">the release on Github</a>.
+
+Wowee, way to go team, contributors, and the community! Please report any issues or questions that you might have to <a href="https://github.com/singularityware/singularity/issues/new" target="_blank">our issue board</a>.
+
+Thank you!