Categorize articles in AppDev, Team, Platform pages (#300)

* Add subcategories to Platform, AppDev, Team articles * Add sidenav to category pages
GSA-TTS · Aug 31, 2022 · 20dec61 · 20dec61
1 parent 1987e6d
commit 20dec61
Show file tree

Hide file tree

Showing 38 changed files with 104 additions and 35 deletions.
diff --git a/_articles/accounts.md b/_articles/accounts.md
@@ -3,6 +3,7 @@ title: "Services and Accounts"
 description: "List of external services and logins to manage"
 layout: article
 category: "Team"
+subcategory: People Ops
 ---
 
 Per our [onboarding][onboarding] and [offboarding][offboarding] instructions, please add people when

diff --git a/_articles/appdev-key-rotation-guide.md b/_articles/appdev-key-rotation-guide.md
@@ -3,5 +3,6 @@ title: "Key rotation guide"
 description: "Guide for rotating secrets for the IdP and PKI codebases"
 layout: article
 category: AppDev
+subcategory: Tasks
 redirect_to: https://docs.google.com/document/d/1mvKQ2lGcjFurAfjn-PNopORHgkamnxpyj8Z4UmGNIi4
 ---
diff --git a/_articles/biannual-review.md b/_articles/biannual-review.md
@@ -3,6 +3,7 @@ title: "Reviews"
 description: "Mid-Year and End-of-Year Self Review and Peer Feedback"
 layout: article
 category: Team
+subcategory: People Ops
 ---
 
 A process to request, gather, and deliver peer feedback and self review on a bi-annual basis. We will use required review cycles not just to check boxes for GSA, but also to help people thrive, grow, and succeed.

diff --git a/_articles/cost-recoverability.md b/_articles/cost-recoverability.md
@@ -1,9 +1,9 @@
 ---
 title: Funding and Cost Recoverability
 layout: article
-description: |
-  How Login.gov is funded and what it means
+description: How Login.gov is funded and what it means
 category: Team
+subcategory: Program Information
 ---
 
 ## Overview

diff --git a/_articles/incident-response-checklist.md b/_articles/incident-response-checklist.md
@@ -3,6 +3,7 @@ title: "Incident Response Checklist"
 description: "Quick reference checklist for incident response"
 layout: article
 category: "Team"
+subcategory: Guides
 ---
 
 This is a quick checklist for any incident (security, privacy, outage, degraded service, etc.) to ensure the team can focus on time critical mitigation/remediation while still communicating appropriately.

diff --git a/_articles/leave-guidance.md b/_articles/leave-guidance.md
@@ -2,6 +2,7 @@
 title: Leave Guidance
 layout: article
 category: Team
+subcategory: People Ops
 ---
 
 ## Login.gov Leave Guidance

diff --git a/_articles/offboarding.md b/_articles/offboarding.md
@@ -2,6 +2,7 @@
 title: "Offboarding"
 layout: article
 category: Team
+subcategory: People Ops
 ---
 
 ## Full Offboarding

diff --git a/_articles/onboarding.md b/_articles/onboarding.md
@@ -2,6 +2,7 @@
 title: Onboarding
 layout: article
 category: Team
+subcategory: People Ops
 ---
 
 ## TTS Onboarding

diff --git a/_articles/openssl-recipes.md b/_articles/openssl-recipes.md
@@ -2,6 +2,7 @@
 title: "Troubleshooting OpenSSL Command Line Recipes"
 description: "Commands for common certificate tasks, useful for PIV/CAC or AAMVA credentials"
 layout: article
+subcategory: "X509 and PIV/CAC Certificates"
 category: "AppDev"
 ---
 

diff --git a/_articles/orgchart.md b/_articles/orgchart.md
@@ -2,5 +2,6 @@
 title: "Org Chart"
 layout: article
 category: "Team"
+subcategory: Team Organization
 redirect_to: https://docs.google.com/spreadsheets/d/1tiTR2ohdl0NIsrF4gJjNipEZ0z0oq1pOFWYjHg8Tbi0/edit#gid=0
 ---
diff --git a/_articles/overtime.md b/_articles/overtime.md
@@ -2,6 +2,7 @@
 title: Overtime
 layout: article
 category: Team
+subcategory: People Ops
 ---
 
 For contractors, Login.gov has a default 45 hour cap on hours worked per week.

diff --git a/_articles/pii-guidance.md b/_articles/pii-guidance.md
@@ -3,6 +3,7 @@ title: "PII Guidance"
 description: "Guidance on safe handling of Personally Identifiable Information"
 layout: article
 category: "Team"
+subcategory: Guides
 ---
 
 ## Overview

diff --git a/_articles/platform-acceptance-criteria.md b/_articles/platform-acceptance-criteria.md
@@ -4,6 +4,7 @@ description: "Detailed guide on how to file Issues and Pull Requests for the Log
 layout: article
 redirect_from:
 category: Platform
+subcategory: Team
 ---
 
 ## Overview

diff --git a/_articles/platform-aliases.md b/_articles/platform-aliases.md
@@ -3,5 +3,6 @@ title: "Custom Aliases/Functions for identity-devops Commands"
 description: "Reference/runbook for the custom commands created via the login-alias script."
 layout: article
 category: Platform
+subcategory: References
 redirect_to: https://github.com/18F/identity-devops/wiki/Custom-Aliases-and-Functions-for-identity-devops
 ---
diff --git a/_articles/platform-auto-tf-runbook.md b/_articles/platform-auto-tf-runbook.md
@@ -2,6 +2,7 @@
 title: "Infrastructure auto-terraform Runbook"
 description: How to use/manage/understand auto-terraform
 layout: article
+subcategory: How To
 category: Platform
 ---
 

diff --git a/_articles/platform-baking-amis.md b/_articles/platform-baking-amis.md
@@ -3,5 +3,6 @@ title: "Baking New AWS AMI Images"
 description: Runbook for creating new Base and Rails AMI images
 layout: article
 category: Platform
+subcategory: How To
 redirect_to: https://github.com/18F/identity-devops/wiki/Baking-New-AWS-AMI-Images
 ---
diff --git a/_articles/platform-ceremonies.md b/_articles/platform-ceremonies.md
@@ -3,6 +3,7 @@ title: "Team Radia Sprint Ceremonies"
 description: "How Sprints and Standups operate"
 layout: article
 category: Platform
+subcategory: Team
 ---
 
 We currently use the **Login.gov Infrastructure** board <https://github.com/orgs/18F/projects/5> to track our current sprint, as well as the issues in our backlog.

diff --git a/_articles/platform-deploy-devops-code.md b/_articles/platform-deploy-devops-code.md
@@ -3,5 +3,6 @@ title: "Deploying Infrastructure Code"
 description: Runbook for the process of deploying code from 18f/identity-devops into our infrastructure.
 layout: article
 category: Platform
+subcategory: How To
 redirect_to: https://github.com/18F/identity-devops/wiki/Deploying-Infrastructure-Code
 ---
diff --git a/_articles/platform-disaster-runbooks.md b/_articles/platform-disaster-runbooks.md
@@ -3,6 +3,7 @@ title: "Platform Disaster Runbooks"
 description: Recovering from really really bad stuff
 layout: article
 category: Platform
+subcategory: How To
 redirect_to: https://github.com/18F/identity-devops/wiki/Disaster-Recovery:-Recovering-RDS-and-KMS
 ---
 
diff --git a/_articles/platform-external-services-and-limits.md b/_articles/platform-external-services-and-limits.md
@@ -3,5 +3,6 @@ title: "External Services and Limits"
 description: Notes on rate and cost limited external services used by IdP and out platform
 layout: article
 category: Platform
+subcategory: References
 redirect_to: https://github.com/18F/identity-devops/wiki/External-Services-and-Limits
 ---
diff --git a/_articles/platform-load-testing-process.md b/_articles/platform-load-testing-process.md
@@ -3,5 +3,6 @@ title: "Load Testing Process"
 description: Process overview and instruction for performing load tests in AWS
 layout: article
 category: Platform
+subcategory: How To
 redirect_to: https://github.com/18F/identity-devops/wiki/Load-Testing
 ---
diff --git a/_articles/platform-oncall-guide.md b/_articles/platform-oncall-guide.md
@@ -2,6 +2,7 @@
 title: "Platform On-Call Guide"
 description: Runbook/guide for processes/responsibilities for the on-call platform engineers.
 layout: article
+subcategory: How To
 category: Platform
 ---
 

diff --git a/_articles/platform-scaling.md b/_articles/platform-scaling.md
@@ -3,5 +3,6 @@ title: "Platform Scaling"
 description: Runbooks for scaling out or up various resources in anticipation of or response to added load
 layout: article
 category: Platform
+subcategory: How To
 redirect_to: https://github.com/18F/identity-devops/wiki/Infrastructure-Scaling
 ---
diff --git a/_articles/platform-set-up-personal-sandbox.md b/_articles/platform-set-up-personal-sandbox.md
@@ -3,5 +3,6 @@ title: "Building a Personal Sandbox Environment"
 description: 'This is a guide to follow when you are standing up your own personal development environment, aka "sandbox"'
 layout: article
 category: Platform
+subcategory: How To
 redirect_to: https://github.com/18F/identity-devops/wiki/Building-a-Personal-Sandbox-Environment
 ---
diff --git a/_articles/platform-setting-up-aws-vault.md b/_articles/platform-setting-up-aws-vault.md
@@ -3,5 +3,6 @@ title: "Setting Up aws-vault"
 description: This runbook is for getting set up with, and using, `aws-vault`, a tool for providing easier access for cross-account role assumption.
 layout: article
 category: Platform
+subcategory: How To
 redirect_to: https://github.com/18F/identity-devops/wiki/Setting-Up-AWS-Vault
 ---
diff --git a/_articles/project-principles.md b/_articles/project-principles.md
@@ -4,6 +4,7 @@ layout: article
 description: |
   Our mission and project principles
 category: Team
+subcategory: Program Information
 ---
 
 ## Our vision

diff --git a/_articles/slack.md b/_articles/slack.md
@@ -3,6 +3,7 @@ title: Slack
 description: Groups and Channels
 layout: article
 category: Team
+subcategory: Team Organization
 toc_h_max: 4
 ---
 

diff --git a/_articles/sprint-teams.md b/_articles/sprint-teams.md
@@ -3,6 +3,7 @@ title: "Sprint Teams"
 description: "List of our sprint teams and the explanations behind their names"
 layout: article
 category: "Team"
+subcategory: Team Organization
 ---
 
 Here are the Login.gov sprint teams, most of them are named after famous women in STEM fields.

diff --git a/_articles/staffing.md b/_articles/staffing.md
@@ -3,6 +3,7 @@ title: "Staffing"
 description: ""
 layout: article
 category: Team
+subcategory: People Ops
 ---
 
 ## Login.gov staffing change process

diff --git a/_articles/team-roles.md b/_articles/team-roles.md
@@ -3,6 +3,7 @@ title: "Sprint Team Roles"
 description: "List of our sprint team roles and responsibilities"
 layout: article
 category: "Team"
+subcategory: Team Organization
 ---
 
 Here are the current Login.gov sprint team roles and responsibilities.

diff --git a/_articles/toubleshooting-expiring-pivcac.md b/_articles/toubleshooting-expiring-pivcac.md
@@ -2,6 +2,7 @@
 title: "Troubleshooting expiring PIV/CAC certs"
 description: "Guide on finding new certs if a cert is expiring"
 layout: article
+subcategory: "X509 and PIV/CAC Certificates"
 category: "AppDev"
 ---
 

diff --git a/_articles/troubleshooting-pivcacs.md b/_articles/troubleshooting-pivcacs.md
@@ -2,6 +2,7 @@
 title: "Troubleshooting PIV/CAC logins and Managing Certificates"
 description: "If somebody has trouble using their PIV/CAC with Login.gov, and also how to download new certificates from Certificate Authorities"
 layout: article
+subcategory: "X509 and PIV/CAC Certificates"
 category: "AppDev"
 ---
 

diff --git a/_categories/architecture.md b/_categories/architecture.md
@@ -2,4 +2,5 @@
 title: Architecture
 layout: category
 icon: account_balance
+description: High-level architecture explanations
 ---
diff --git a/_layouts/article.html b/_layouts/article.html
@@ -21,9 +21,6 @@
   <div class="tablet:grid-col-8">
     <div class="usa-prose" role="main">
       <h1>
-        {% if page.icon %}
-          {% include uswds-icon.html icon=page.icon %}
-        {% endif %}
         {{ page.title }}
         {% if page.deprecated %}
           <small>(Deprecated)</small>

diff --git a/_layouts/category.html b/_layouts/category.html
@@ -0,0 +1,48 @@
+---
+layout: default
+---
+
+{% capture content_markdown %}
+
+{{ page.description }}
+
+{{ content }}
+
+### Articles
+
+{% include articles_category.md category=page %}
+
+{% endcapture %}
+
+{% assign content_html = content_markdown | markdownify %}
+
+
+<div class="grid-row grid-gap">
+  <aside class="tablet:grid-col-3">
+    <nav id="sidenav-wrapper">
+      {% assign h_max = page.toc_h_max | default: 4 %}
+      {% include toc.html
+                 html=content_html
+                 sanitize=true
+                 class="inline_toc usa-accordion usa-sidenav"
+                 id="sidenav"
+                 item_class="usa-sidenav__item"
+                 submenu_class="usa-sidenav__sublist"
+                 h_min=2
+                 h_max=h_max %}
+    </nav>
+  </aside>
+
+  <div class="tablet:grid-col-8">
+    <div class="usa-prose" role="main">
+      <h1>
+        {% if page.icon %}
+          {% include uswds-icon.html icon=page.icon %}
+        {% endif %}
+        {{ page.title }}
+      </h1>
+
+      {{ content_html }}
+    </div>
+  </div>
+</div>
diff --git a/_layouts/category.md b/_layouts/category.md
diff --git a/assets/js/setup.tsx b/assets/js/setup.tsx
@@ -6,7 +6,7 @@ import { setUpPrivateLogin } from "./private";
 
 export const loadAnchors = () => {
   new Anchor().add(
-    "#main-content h2, #main-content h3, #main-content [data-anchor]"
+    "#main-content h2, #main-content h3, #main-content h4, #main-content [data-anchor]"
   );
 };
 

diff --git a/index.md b/index.md
@@ -16,24 +16,28 @@ to [avoid contributing sensitive information][sensitive-information].
 <div class="margin-bottom-4"></div>
 
 <ul class="usa-card-group">
-  {% for category in site.categories %}
-    <li class="usa-card tablet:grid-col-6">
-      <div class="usa-card__container">
-        <div class="usa-card__header">
-          <span class="usa-card__heading">
-            {% if category.icon %}
-              {% include uswds-icon.html icon=category.icon %}
-            {% endif %}
-            <strong>
-              <a href="{{ category.url | prepend: site.baseurl }}" class="usa-link">{{ category.title }}</a>
-            </strong>
-          </span>
+  {% assign sorted_categories = site.categories | group_by: 'order' | sort: 'name' %}
+  {% for category_group in sorted_categories %}
+    {% assign sorted_category_items = category_group.items | sort: 'title' %}
+    {% for category in sorted_category_items %}
+      <li class="usa-card tablet:grid-col-6">
+        <div class="usa-card__container">
+          <div class="usa-card__header">
+            <span class="usa-card__heading">
+              {% if category.icon %}
+                {% include uswds-icon.html icon=category.icon %}
+              {% endif %}
+              <strong>
+                <a href="{{ category.url | prepend: site.baseurl }}" class="usa-link">{{ category.title }}</a>
+              </strong>
+            </span>
+          </div>
+          <div class="usa-card__body">
+            <p>{{ category.description }}</p>
+          </div>
         </div>
-        <div class="usa-card__body">
-          <p>{{ category.description }}</p>
-        </div>
-      </div>
-    </li>
+      </li>
+    {% endfor %}
   {% endfor %}
 </ul>