Merge pull request #152 from secure-systems-lab/retired-projects

Change handling of retired projects

Author: adityasaky

.github/workflows/test_yaml.yml

@@ -20,7 +20,7 @@ jobs:
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
-        python -m pip install yamale colorama
+        python -m pip install -r requirements.txt
     - name: Test yaml
       run: |
         _test/test_yaml.py

.gitignore

@@ -46,3 +46,6 @@ node_modules
 # Jekyll
 .jekyll-metadata
 .jekyll-cache
+
+# Ruby
+.bundle

_data/data.yml

@@ -701,15 +701,19 @@ projects:
     statuses:
     - &stealth
         name: "Stealth Mode"
+        tag: "stealth"
         description: "Shhhh.  We're still figuring things out internally."
     - &starting
         name: <span style="color:green">Sprouting</span>
+        tag: "sprouting"
         description: "We're ready for use.  Early adopters wanted!"
     - &adopted
         name: <span style="color:gold">Adopted</span>
+        tag: "adopted"
         description: "Many people are using this.  Join them!"
     - &retired
         name: <span style="color:silver">Retired</span>
+        tag: "retired"
         description: "We learned what we can and are not actively developing anymore."
 
     tags:
@@ -744,10 +748,10 @@ projects:
         name: "Testing Tools"
         anchor: testing_tools
 
-    intro: "Though all of SSL’s research initiatives—past and present—revolve
-    around ensuring secure operation of computer systems, the specific areas
-    addressed by the team vary greatly. Initiatives are grouped into
-    the following categories:"
+    intro: "Though all of SSL’s research initiatives—<a href='retired-projects'>past</a>
+    and <a href='projects'>present</a>—revolve around ensuring secure operation
+    of computer systems, the specific areas addressed by the team vary greatly.
+    Initiatives are grouped into the following categories:"
 
     projects:
     - &tuf

_test/data/test_01_projects_vs_project.yml

@@ -26,6 +26,7 @@ projects:
     statuses:
     - &stealth
         name: "Stealth Mode"
+        tag: "stealth"
         description: "Shhhh.  We're still figuring things out internally."
 
     tags:

_test/data/test_02_project_list_vs_str.yml

@@ -26,6 +26,7 @@ projects:
     statuses:
     - &stealth
         name: "Stealth Mode"
+        tag: "stealth"
         description: "Shhhh.  We're still figuring things out internally."
 
     tags:

_test/data/test_03_misspelled_alias.yml

@@ -26,6 +26,7 @@ projects:
     statuses:
     - &stealth
         name: "Stealth Mode"
+        tag: "stealth"
         description: "Shhhh.  We're still figuring things out internally."
 
     tags:

_test/data/test_04_unescaped_quotes.yml

@@ -26,6 +26,7 @@ projects:
     statuses:
     - &stealth
         name: "Stealth Mode"
+        tag: "stealth"
         description: "Shhhh.  We're still figuring things out internally."
 
     tags:

_test/data/test_05_alias_instead_of_str.yml

@@ -26,6 +26,7 @@ projects:
     statuses:
     - &stealth
         name: "Stealth Mode"
+        tag: "stealth"
         description: "Shhhh.  We're still figuring things out internally."
 
     tags:

_test/data/test_data.yml

@@ -26,6 +26,7 @@ projects:
     statuses:
     - &stealth
         name: "Stealth Mode"
+        tag: "stealth"
         description: "Shhhh.  We're still figuring things out internally."
 
     tags:

_test/yamale_schema.yml

@@ -29,7 +29,6 @@ person:
     since: any(int(min=2010,max=2025), str())
     interests: str()
     photo: str()
-    interests: str()
     publications: list(include('person_publication'), required=False)
     deployments: str(required=False)
 
@@ -59,6 +58,7 @@ proj_person:
 
 status:
     name: str()
+    tag: str()
     description: str()
 
 tag:

js/project_tags.js

@@ -5,6 +5,9 @@
 
 // Populate a master hash with the mapping of tag_name=>project_name
 {% for project in site.data.data.projects.project_cards %}
+  {% if project.status.tag == "retired" %}
+    {% continue %}
+  {% endif %}
    {% for tag in project.tags %}
      mapTagToAnchor(    '{{ tag.anchor }}', '{{ project.anchor }}');
      mapTagToPrettyName('{{ tag.anchor }}', '{{ tag.name }}');

js/retired_project_tags.js

@@ -0,0 +1,18 @@
+---
+---
+
+{% include filter_tags_preamble.js %}
+
+// Populate a master hash with the mapping of tag_name=>project_name
+{% for project in site.data.data.projects.project_cards %}
+  {% if project.status.tag != "retired" %}
+    {% continue %}
+  {% endif %}
+   {% for tag in project.tags %}
+     mapTagToAnchor(    '{{ tag.anchor }}', '{{ project.anchor }}');
+     mapTagToPrettyName('{{ tag.anchor }}', '{{ tag.name }}');
+   {% endfor %}
+{% endfor %}
+
+{% include filter_tags.js pagename='project' %}
+

projects.html

@@ -12,6 +12,12 @@
 
 <div class="projects">
   {% for project in site.data.data.projects.project_cards %}
+    {% if project.status %}
+    <!-- FIXME: do we ever not have project status associated? -->
+      {% if project.status.tag == "retired" %}
+        {% continue %}
+      {% endif %}
+    {% endif %}
   <div class="project">
     <a class="anchor" name="{{ project.anchor }}"></a>
 
@@ -84,6 +90,17 @@ <h3><a href="#{{ project.anchor }}"> {{ project.name | size_upcase }} </a></h3>
     </ul>
   </div>
   {% endfor %}
+  <div class="project">
+    <p>
+      During its tenure, the Secure Systems Laboratory has developed, nurtured, and deployed a number of technologies,
+      which have been sunsetted. These projects addressed password protection, secure experimental testbeds, the
+      factors that influence developer perceptions, as well as a vehicle to securely share (and acquire) donated computing
+      resources from desktops, laptops, or smartphones that in some ways anticipated the growth of cloud computing. Though
+      these technologies are no longer being actively developed, the resources generated by these projects can still
+      largely be accessed. You can learn more about these retired technologies by clicking <a
+        href="retired-projects">here</a>.
+    </p>
+  </div>
 </div>
 
 <div id="action-flash" class="fade-out"></div>

requirements.txt

@@ -0,0 +1,3 @@
+colorama==0.4.6
+PyYAML==6.0
+yamale==4.0.4

retired-projects.html

@@ -0,0 +1,97 @@
+---
+title: Retired Projects
+subnav: retired-projects
+layout: default
+---
+
+<link rel="stylesheet" href="{{ site.baseurl }}css/projects.css"></link>
+
+<div class="intro">{{ site.data.data.projects.intro }}</div>
+
+<ul class="toc" id="tags-toc"></ul>
+
+<div class="projects">
+  {% for project in site.data.data.projects.project_cards %}
+    {% if project.status %}
+    <!-- FIXME: do we ever not have project status associated? -->
+      {% if project.status.tag != "retired" %}
+        {% continue %}
+      {% endif %}
+    {% endif %}
+  <div class="project">
+    <a class="anchor" name="{{ project.anchor }}"></a>
+
+    <div class="title-bar">
+       <h3><a href="#{{ project.anchor }}"> {{ project.name | size_upcase }} </a></h3>
+         <div class="link-list">
+           <div class="press-link">
+             {% capture press_projects %}{{ site.data.data.press.presses | map: 'project' | map: 'anchor' }}{% endcapture %}
+             {% if press_projects contains project.anchor %}
+               <a href="/press?filter={{ project.anchor }}">(press)</a>
+             {% endif %}
+	   </div>
+           <div class="pubs-link">
+             {% capture pub_projects %}{{ site.data.data.publications.publications | map: 'project' | map: 'anchor' }}{% endcapture %}
+             {% if pub_projects contains project.anchor %}
+               <a href="/publications?filter={{ project.anchor }}">(publications)</a>
+             {% endif %}
+	   </div>
+           <div class="web-link">
+             {% if project.site %}
+               <a href="{{ project.site }}">(website)</a>
+             {% endif %}
+           </div>
+	 </div>
+       {% if project.status %}
+         <span class="status tooltip-wrapper"> {{ project.status.name }}
+           <div class="tooltip"> {{ project.status.description }} </div>
+         </span>
+       {% endif %}
+    </div>
+    {% if project.tags %}
+      <div class="tags">
+        {{ project.tags | map: 'name' | array_to_sentence_string }}
+      </div>
+    {% endif %}
+
+    <img class="image" src="{{ project.image }}"></img>
+
+    <div class="description"><p>
+      {{ project.description }}
+    </p></div>
+
+    <ul>
+       {% if project.products %}
+         <li>
+           <span class="header">Products: </span>
+           <span class="products">{{ project.products }}</span>
+         </li>
+       {% endif %}
+
+       {% if project.people %}
+          <br />
+          <li><div class="people">
+             <span class="header">People: </span>
+             {% assign personLinks = '' | split:':' %}
+             {% for person in project.people %}
+             {% if person == nil %}
+                 {% capture personLink %}<span style="color: red;">NAME MISSING</span>{% endcapture %}
+             {% else %}
+                 {% assign defaultLink = "people#" | append: person.anchor %}
+                 {% capture personLink %}{% if person.link or person.anchor %}<a class={% if
+             person.internal %}"internal"{% else %}"external"{% endif %} href="{{ person.link | default: defaultLink}}">{% endif %}{{ person.name }}{% if person.link %}</a>{% endif %}{% endcapture %}
+             {% endif %}
+               {% assign personLinks = personLinks | push: personLink %}
+             {% endfor %}
+
+             {{ personLinks | array_to_sentence_string }}
+          </div></li>
+       {% endif %}
+    </ul>
+  </div>
+  {% endfor %}
+</div>
+
+<div id="action-flash" class="fade-out"></div>
+
+<script src="{{ site.baseurl }}js/retired_project_tags.js"></script>